説明
string sanitize_email( string $email )
メールアドレスとして無効な文字を除外する。
パラメータ
- $emailメールアドレスを指定。
返り値
無効な文字を除外したメールアドレスを返す。無効な書式の場合は''を返す。
注意
本関数はプラグインやテーマで使用できるほか、標準で'pre_comment_author_email'、 'pre_user_email'、 'comment_author_email'、 'user_email'フィルターとして登録されている。
メールアドレスとして無効な文字を除外する前に書式のチェックが行われ、エラーが見つかった場合はその内容を示すメッセージを含めた'sanitize_email'フィルターを呼び出す。
| $messageの内容 | 意味 |
|---|---|
| 'email_too_short' | $emailが6文字未満 |
| 'email_no_at' | 2文字目以降に'@'がない |
| 'local_invalid_chars' | ローカル部に有効な文字がない |
| 'domain_period_sequence' | ドメイン部から連続する'.'を除外すると有効な文字がない |
| 'domain_period_limits' | ドメイン部の先頭および末尾の空白文字と'.'を除外すると有効な文字がない |
| 'domain_no_periods' | ドメイン部が単独の'.'で区切られていない |
| 'domain_no_valid_subs' | ドメイン部に第2レベルドメインがない |
使用例
- 変数$emailについてメールアドレスとして無効な文字を除外する。
<?php $sanitized_email = sanitize_email( $email ); ?>
フィルター
[2.8.0]メールアドレスを返す前に'sanitize_email'フィルターを呼び出す。パラメータ$sanitized_emailには無効な文字を除外したメールアドレス（書式が無効な場合は''）が、$emailには本関数が受け取った内容が、$messageにはnull（書式が無効な場合はその旨を示す文字列）が格納されている。return apply_filters( 'sanitize_email', $sanitized_email, $email, $message );アクション
実行するアクションはありません。ソースファイル
/wp-includes/formatting.php最終更新 : 2019年04月24日 16:12
関連
お勧め
WP_Postオブジェクトで投稿情報を直感的に使う（2012年10月4日 更新）
WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。さくらのVPSでKUSANAGI#2（2018年5月27日 更新）
今回は「前回」の続き。さくらのVPS（メモリー2GB SSDプラン）でパフォーマンスをApacheのabコマンドで確認してみた。はてさて、うたい文句通りのパフォーマンスは発揮するのだろうか。
タイトルのみをキーワード検索する（2014年4月3日 更新）
WordPressのキーワード検索は、投稿タイトルと本文のどちらかに指定したキーワードが含まれているかを調べるわけだが、時々タイトルだけとか、逆に本文だけ検索したいケースがある。
Login rebuilder 2.6.0の新機能紹介（2019年4月22日 更新）
今回追加したものは、REST API / Usersの使用をログイン時のみ使用できるように制限する機能である。この機能を有効にすることで、管理者情報が漏洩するリスクを低減させる効果が期待できる。
Blacklist keys manager：プラグイン作ってみました（2015年5月22日 更新）
少し前から明らかにスパムと思われるコメントが投稿され、そのモデレーションメールを受け取る回数が増えてきた。あまりにもあからさまなコメントばかりなので、何らかの対策ができないか考えてみました。