wp_update_user()


WordPressのwp_update_user()関数は、ユーザーの情報を更新するために使用されます。ユーザーIDを指定して、ユーザーの名前、メールアドレス、パスワードなどの情報を更新できます。

構文

wp_update_user( array|object|int $userdata );
  • $userdata(array|object|int) — 更新するユーザーのデータ。ユーザーIDを直接指定するか、配列やオブジェクト形式でユーザー情報を渡します。

例1: ユーザーの表示名を更新

この例では、IDが1のユーザーの表示名を「新しい表示名」に更新します。

wp_update_user( array( 'ID' => 1, 'display_name' => '新しい表示名' ) );

例2: ユーザーのメールアドレスを更新

この例では、現在のユーザーのメールアドレスを「newemail@example.com」に更新します。

wp_update_user( array( 'ID' => get_current_user_id(), 'user_email' => 'newemail@example.com' ) );

例3: ユーザーのパスワードを更新

この例では、IDが2のユーザーのパスワードを「newpassword」に更新します。

wp_update_user( array( 'ID' => 2, 'user_pass' => 'newpassword' ) );

例4: ユーザーのログイン名を更新

この例では、IDが3のユーザーのログイン名を「newloginname」に更新します。

wp_update_user( array( 'ID' => 3, 'user_login' => 'newloginname' ) );

例5: ユーザーのURLを更新

この例では、IDが4のユーザーのURLを「https://example.com」に更新します。

wp_update_user( array( 'ID' => 4, 'user_url' => 'https://example.com' ) );

例6: ユーザーの役割を更新

この例では、IDが5のユーザーの役割を「editor」に更新します。

wp_update_user( array( 'ID' => 5, 'role' => 'editor' ) );

例7: 複数のユーザー情報を一度に更新

この例では、IDが6のユーザーの表示名とメールアドレスを同時に更新します。

wp_update_user( array( 'ID' => 6, 'display_name' => '新しい名前', 'user_email' => 'newemail@example.com' ) );

例8: オブジェクト形式でユーザー情報を更新

この例では、オブジェクト形式でユーザー情報を渡して更新します。

$user = new stdClass();
$user->ID = 7;
$user->display_name = 'オブジェクト名';
wp_update_user( $user );

注意点

  • ユーザーIDが存在しない場合、関数はエラーを返します。
  • パスワードを更新する場合、ハッシュ化された状態で保存されます。
  • ユーザーログイン名の変更は慎重に行ってください。既存のログイン名と重複するとエラーが発生します。

関連機能：