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



お勧め

「投稿に挿入」時のタグをちょっとカスタマイズ(2011年7月29日 更新)

投稿画面において、画像をアップロードし投稿に挿入するすると、imgタグをaタグで囲んだものが挿入される(キャプションを指定した場合はタグも)。それらの画像をLightBox(JavaScriptライブラリ)で表示する場合、aタグにrel属性を追加するのだが、その作業を毎回投稿に挿入した後で行うのがちょっと面倒。というわけで、自動的にrel属性を追加するようにしてみました。

5.3への準備:投稿写真を使っているサイトは準備しておこう(2019年10月10日 更新)

この記事は先日公開した「5.3の新機能:JPEG画像の向きを調整」の続きのようなものになる。高解像度の投稿写真を扱っているサイトは、5.3のリリースに合わせて対応を検討しておくべきことをまとめてみた。

Blacklist keys manager:プラグイン作ってみました(2015年5月22日 更新)

少し前から明らかにスパムと思われるコメントが投稿され、そのモデレーションメールを受け取る回数が増えてきた。あまりにもあからさまなコメントばかりなので、何らかの対策ができないか考えてみました。

get_postsとquery_postsを使い分け(2018年5月27日 更新)

get_posts query_postsは、どちらも複数の投稿情報を取得することができる便利な関数である。パラメータとして指定できる内容も共通しているものが多く、query_postsがより詳細なパラメータを指定でき、高機能になっている。

wp_titleからwp_get_document_titleへ(2018年5月27日 更新)

先週、WordPress 4.4 beta1(以降4.4 beta1)が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。