ワードプレスのusername_exists関数の使用方法・解説

概要

username_exists関数は、指定したユーザ名が既に登録されているかどうかを確認するための関数です。この関数は、ユーザ登録機能を実装する際によく使われます。以下は、username_exists関数がよく使用される場面の例です。

1. 新規ユーザ登録フォームでのユーザ名の重複チェック
2. ユーザ名変更機能での重複チェック
3. パスワードリセット機能でのユーザの確認
4. SNSログインなど外部サービスとの連携時のユーザ名確認
5. 既存ユーザデータのインポート時の重複防止
6. カスタムユーザロールを持つユーザの確認
7. ユーザ名に基づいたドキュメントやコンテンツの閲覧制限
8. リファラルプログラムにおける紹介ユーザ名の重複チェック

構文

$username = 'example_username';
if (username_exists($username)) {
    // ユーザ名は既に存在します
} else {
    // ユーザ名は存在しません
}

パラメータ

• username (string): 確認したいユーザ名。

戻り値

• 存在する場合はユーザのID (int) を返し、存在しない場合は false を返します。

関連する関数

• is_user_logged_in
• email_exists
• get_userdata

使用可能なバージョン

• username_exists関数は、WordPress 1.5.0以降で使用できます。

コアファイルのパス

• wp-includes/user.php

この関数のアクションでの使用可能性

アクション	使用例
mu_plugin_loaded
registered_post_type
plugins_loaded
wp_roles_init
setup_theme
after_setup_theme
set_current_user
init	〇
register_sidebar
wp_loaded
send_headers
parse_query
pre_get_posts
wp
template_redirect
get_header
wp_head

非推奨または削除されたバージョン

• 特に非推奨または削除されたバージョンはありません。