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

説明

username_exists() は、指定したユーザー名(ログイン名)が既に使われているかを調べる関数です。

基本構文

username_exists( string $username ): int|false

引数

  • $username:ログイン名

戻り値

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

使い方(サンプル)

if ( ! username_exists( 'taro' ) ) {
	// 作成してよい
}

注意点

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

実務での使いどころ

  • ユーザー登録の前に、ユーザー名が重複していないかを確認するとき。

よくあるミスと対処

  • 戻り値が、ユーザーID(整数)または false であることを忘れ、true と比べている。
  • 入力値を、サニタイズしていない。

NG例

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

OK例

if ( username_exists( sanitize_user( $name ) ) ) {
	// すでに使われている
}

使い分け早見表

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

関連項目

email_exists()、wp_create_user()

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

コメント

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