説明
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
関連
お勧め
テキストエディタの文字を変更する（2018年5月27日 更新）
テキストエディタ（投稿ページの「テキスト」タブのエディタ）に標準では備わっていない機能を追加する自作プラグイン「html entities button」がほぼ1年ぶりにアップデート。ここではバージョン2.0.0で追加したテキストエディタのフォント切り替え機能について紹介する。
query_posts（WP_Queryクラス）でカスタムフィールドを使う（2011年9月15日 更新）
先週3回にわたってtax_queryパラメータを使ったカテゴリーや投稿タグ、投稿フォーマットの絞り込みを整理したが、その途中で目に付いたのが'meta_query'パラメータ。この'meta_query'パラメータは、カスタムフィールドの絞り込み条件を指定するためのもので、3.2で登場した新しいパラメータのようだ。更新ボタンの横にスピナーを実装する（2019年5月14日 更新）
WordPressの管理画面ではAJAXを使って何らかの処理を行う際、数秒間の空き時間にアイコンがクルクル回る「スピナー」を表示しているところがある。今作っているプラグインでこの「スピナー」を使いたくなったので、実装方法を調べてみた。
公式ディレクトリに登録するならajax.googleapis.comのライブラリは利用しない（2018年5月27日 更新）
数日前、投稿一覧ページの絞り込みドロップダウンメニューを複数選択可能にするプラグイン「Posts filter multiselect」を公開したのですが、その際に指摘されたポイントを紹介します。
Login rebuilder 2.3.0の新機能を紹介（2018年5月27日 更新）
プラグイン「Login rebuilder」はログイン時の履歴（ログ）や不正なログインページへのアクセス履歴を保存している。これらの履歴情報はダッシュボートで確認できるが、バージョン2.3.0においてそれぞれがダウンロードできるようになった。