sanitize_email() の使い方|説明・引数・注意点

説明

sanitize_email() は、メールアドレスとして使えない文字を取り除く関数です。

基本構文

sanitize_email( string $str ): string

引数

  • $str:処理する文字列

戻り値

サニタイズ済みの文字列。

使い方(サンプル)

$mail = sanitize_email( $input );

注意点

  • 整形だけを行い、アドレスが有効かは検証しません。検証には is_email() を使います。

実務での使いどころ

  • メールアドレスの入力値から、使えない文字を、取り除くとき。

よくあるミスと対処

  • 整えただけで、正しいメールアドレスだと考えている。形式の確認は、is_email()。
  • 不正な値では、空文字が返る。確認せずに使う。

NG例

update_option( 'admin_mail', sanitize_email( $email ) ); // 空文字でも、そのまま保存される

OK例

$email = sanitize_email( wp_unslash( $_POST['email'] ) );
if ( is_email( $email ) ) {
	update_option( 'admin_mail', $email );
}

使い分け早見表

関数 役割
sanitize_email() メールアドレスを、使える文字だけに整える
is_email() メールアドレスの形式を、確認する
sanitize_text_field() 1行のテキストを整える

関連項目

is_email()、sanitize_text_field()

公式リファレンス:sanitize_email() | Function | WordPress Developer Resources

コメント

タイトルとURLをコピーしました