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



お勧め

xmlrpc.phpへのアクセスについてちょっと考えた(2018年5月27日 更新)

少し前のことですが、こちらのサーバーを何度かダウンさせてしまったのですが、その原因はxmlrpc.phpへアクセスが集中したことによってサーバーが過負荷となってしまったというものでした。すぐにサーバー性能を上げることはできないため、xmlrpc.phpのアクセスを全部拒否するという暫定対応してしまいました。

開発環境(Windows 8)にimagickを入れる(2012年12月23日 更新)

WordPress 3.5のイメージエディタ(WP_Image_Editor)は、GDだけでなく、imagick(ImageMagick)にも対応している。そんなわけでWindows 8の開発環境にimagickをインストールしてみた。

Post-tag automaton:プラグイン作ってみました(2012年12月24日 更新)

みなさんは投稿をポストする際に投稿タグを付け忘れたことはないでしょうか。このプラグインは、投稿をポストする際にタイトルと記事に投稿タグが含まれていないか調べ、含まれていた場合はその投稿タグを追加します。

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

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

タイトルのみをキーワード検索する(2014年4月3日 更新)

WordPressのキーワード検索は、投稿タイトルと本文のどちらかに指定したキーワードが含まれているかを調べるわけだが、時々タイトルだけとか、逆に本文だけ検索したいケースがある。