wp_insert_user()


WordPress関数wp_insert_user()は、WordPressサイトに新しいユーザーを登録するために使用される関数です。

構文

wp_insert_user( array $userdata );

引数の説明:

  • $userdata (array) — ユーザー情報を含む連想配列。以下のキーが使用可能です:
    • user_login (string) — ユーザー名(必須)。
    • user_pass (string) — パスワード。
    • user_email (string) — ユーザーのメールアドレス。
    • role (string) — ユーザーのロール(例: ‘subscriber’, ‘editor’ など)。
    • first_name (string) — ユーザーの名。
    • last_name (string) — ユーザーの姓。
    • nickname (string) — ニックネーム。
    • display_name (string) — 表示名。

例 1: 基本的なユーザーの登録

以下のコードは、新しいユーザーを登録します。

wp_insert_user( array(
    'user_login' => 'new_user',
    'user_pass'  => wp_generate_password(),
    'user_email' => 'new_user@example.com',
    'role'       => 'subscriber'
) );

例 2: 詳細なユーザー情報を指定して登録

以下のコードは、詳細な情報を含むユーザーを登録します。

wp_insert_user( array(
    'user_login'   => 'example_user',
    'user_pass'    => wp_generate_password(),
    'user_email'   => 'example_user@example.com',
    'first_name'   => 'Taro',
    'last_name'    => 'Yamada',
    'nickname'     => 'TaroYama',
    'display_name' => 'Taro Yamada',
    'role'         => 'editor'
) );

例 3: ユーザー登録のエラーチェック

以下のコードは、登録時にエラーが発生した場合に対処します。

$result = wp_insert_user( array(
    'user_login' => 'test_user',
    'user_email' => 'test_user@example.com',
    'user_pass'  => 'password123'
) );

if ( is_wp_error( $result ) ) {
    echo 'エラー: ' . $result->get_error_message();
}

注意事項

  • ユーザー名 (user_login) とメールアドレス (user_email) はユニークである必要があります。
  • 登録に失敗した場合、is_wp_error() を使用してエラーチェックを行うことが重要です。

関連機能: