説明
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
関連
お勧め
Emojin：プラグイン作ってみました（2015年3月21日 更新）
ちょっと前のTLでiOSの絵文字を含んだ投稿を保存すると、絵文字以降の文章がすべて消えた状態で保存されるといったツイートを見かけた。少し検索してみると、MySQLのデータベースの文字セットが「utf8」の場合、iOSの絵文字のような4バイトの文字を正常に保存できず、それ以降の文章も保存されないというものらしい。対処方法としてデータベースの文字セットを「utf8mb4」に変更するのが有効らしいのだが、他に回避策がないか考えてみた。Twenty Seventeenのフォントサイズを変更してみた（2021年12月15日 更新）
先日投稿した「続テーマを変更せずにWebフォントを使ってみた」では、テーマ「Twenty Seventeen」でもWebフォントを使えるようにした。その際、「Twenty Seventeen」のフォントサイズが少し小さく感じたので、今回はフォントサイズを調整してみた。
HTML entities button：プラグイン作ってみました（2021年4月28日 更新）
以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字（HTMLエンティティ）を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。5.7の機能拡張：エクスポートファイルに更新日時が追加ほか（2021年2月23日 更新）
WordPressはサイト移行を支援する機能として投稿情報のエクスポート機能を備えている。5.7ではこのエクスポート機能が改良され、更新日時情報が追加されるようだ。
query_posts（WP_Queryクラス）でカスタムフィールドを使う（2011年9月15日 更新）
先週3回にわたってtax_queryパラメータを使ったカテゴリーや投稿タグ、投稿フォーマットの絞り込みを整理したが、その途中で目に付いたのが'meta_query'パラメータ。この'meta_query'パラメータは、カスタムフィールドの絞り込み条件を指定するためのもので、3.2で登場した新しいパラメータのようだ。