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

説明

email_exists() は、指定したメールアドレスが既に使われているかを調べる関数です。

基本構文

email_exists( string $email ): int|false

引数

  • $email:メールアドレス

戻り値

存在すればユーザーID、なければ false。

使い方(サンプル)

if ( ! email_exists( 'user@example.com' ) ) {
	// 登録してよい
}

注意点

  • 登録フォームの重複チェックに使います。

実務での使いどころ

  • ユーザー登録の前に、メールアドレスが重複していないかを確認するとき。

よくあるミスと対処

  • 戻り値が、ユーザーID(整数)または false であることを忘れ、true と比べている。
  • 入力値を、検証していない。is_email() で形式を確認する。

NG例

if ( true === email_exists( $email ) ) {
	// 戻り値は ID なので、true とは一致しない
}

OK例

if ( is_email( $email ) && email_exists( $email ) ) {
	// すでに使われている
}

使い分け早見表

やりたいこと 使うもの
メールアドレスの重複を確認 email_exists()
ユーザー名の重複を確認 username_exists()
ユーザーを取得 get_user_by()

関連項目

username_exists()、get_user_by()

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

コメント

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