説明
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
関連
お勧め
囲み型ショートコードとwpautop（2018年5月27日 更新）
ショートコードは投稿記事の閲覧時に動的に内容を変更できる優れもの。galleryやcaptionなどいくつかのショートコードが標準で組み込まれており、一部のプラグインではその機能を利用する手段としてショートコードが利用されている。
使っていないか確認しないとね！（フィルター編）（2019年4月24日 更新）
先週末にWordPress 5.2 Beta3（以降5.2Beta3）が公開され、正式リリースまであとわずか。ソースコードの変更点を見ていくと、wp-login.phpの中に非推奨となったフィルターが目に留まった。
Login rebuilder 2.5.0の新機能紹介（2018年12月10日 更新）
今回追加したものは、任意の名前でロックファイルを設定し、そのファイルが存在する場合は常にログイン不可にする機能である。この機能を有効にしておくことで、何らかの理由により認証に関する情報が漏洩した場合でも不正なログインを防ぐことができる。
時代はWP_Queryなのか（2011年8月1日 更新）
WordPressのテーマ作成において、メインの投稿記事とは別に特定の条件を指定した投稿内容を表示することが多々ある。つい最近まで get_posts関数を使用することが多かったのだが、最近はWP_Queryクラスを使用することが多くなってきた。query_posts（WP_Queryクラス）で'tax_query'を使いこなす（2011年9月14日 更新）
2日にわたって投稿した「query_posts（WP_Queryクラス）でカテゴリーを絞り込む」「query_posts（WP_Queryクラス）で投稿タグを絞り込む」の続き。今日はカテゴリーや投稿タグ以外ののタクソノミーによる絞り込み、複数のタクソノミーの絞り込みの組み合わせについてまとめてみる。