sanitize_email

説明

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



お勧め

4.2で始まるiOSの絵文字ケア(2018年5月27日 更新)

WordPress 4.2のベータ1、ベータ2が立て続けにリリースされ、4.2の正式版リリースが近づいています。4.2のポイントの1つは絵文字のクロスブラウザ対応です。ここでの絵文字とは、UTF-8で4バイトのコードが割り当てられている(基本的にはiOSの)絵文字を指します。この絵文字を含んだ投稿が正しく保存できなかったり、iOS以外の環境で意図した通りに表示できないといった問題があり、4.2ではそのような問題を対処をコードが組み込まれています。

投稿内容のid属性などを保存するための対策(2012年6月15日 更新)

WordPress 3.4にアップデートしたとある環境で投稿記事を保存すると、divタグなどのid属性がクリアされて保存するようになった(id属性が保存できなくなった)。ここでは、その対策方法の1つを紹介しておく。

カレンダーウィジェットをAjaxで切り替える(2011年8月22日 更新)

ウィジェットベースでテーマを構築していてカレンダーを表示してみた。標準では、前月や次月のリンク先はそれぞれの月のアーカイブページとなっているのだが、記事を探すだけであればカレンダー部分だけを更新するほうが便利なのではと考え、そのアイデアを実装してみた。

続テーマを変更せずにWebフォントを使ってみた(2022年2月8日 更新)

先日投稿した「テーマを変更せずにWebフォントを使ってみた」では、テーマ「Twenty Twenty One」でWebフォントを使うことができた。その後、ほかのテーマで試したところ、そのままではWebフォントを使うことができなかった。今回は、それらのテーマの対応について紹介する。

LevelとCapability(2018年5月27日 更新)

プラグインやテーマの管理ページを作成する際など、ユーザのレベルと権限を確認することがある。ここでは、権限グループ別のレベルと権限の有無を整理してみた。