関数リファレンス/wp update user

説明

この関数はデータベース内の1件のユーザー情報を更新します。更新情報には配列としてユーザーメタ情報の複数の項目を含めることができますが、カスタムユーザーメタフィールドは更新しません。この関数が更新できるメタ情報は wp_insert_user() /en と同じです。

ユーザーメタ情報の項目1つを更新するには、update_user_meta() /en を代わりに使ってください。

新規ユーザーを作成したり、パスワード変更メールを送らずに更新したりするには、wp_insert_user() /en を代わりに使ってください。

参考: 現在ログインしているユーザーのパスワードが更新されると、Cookie はクリアされます!

特記事項

(バージョン3.6より前は) $userdata がキー 'ID' を含まなければ、新規ユーザーが作られてそのユーザー ID が返されます。 バージョン3.6以降、このようなことはありませんが、この動作は将来復活するかもしれません。チケット #16731 を見てください。

使い方

<?php wp_update_user( $userdata ) ?>

パラメータ

$userdata

（mixed） （必須） ユーザー情報の配列、stdClass、WP_User オブジェクトのいずれか。

初期値： なし

戻り値

(mixed) 

成功するとユーザー ID を、それ以外の場合は WP_Error オブジェクトを返します。

用例

以下の例はユーザープロフィールの項目「ウェブサイト」を更新する方法を示します:

<?php
$user_id = 1;
$website = 'http://wordpress.org';

$user_id = wp_update_user( array( 'ID' => $user_id, 'user_url' => $website ) );

if ( is_wp_error( $user_id ) ) {
	// エラー発生、おそらくユーザーが存在しなかった。
} else {
	// 成功!
}		

参考

内部で使用する関数

• get_userdata() - 渡された ID からユーザーに紐づく情報のオブジェクトを返します。
• wp_hash_password() /en
• wp_insert_user() /en - ユーザーを更新したり、存在しない場合に作成するために使われます。
• wp_get_current_user() /en
• wp_clear_auth_cookie() /en
• wp_set_auth_cookie() /en

引数の詳細

配列 $userdata には次の項目を含めることができます。

項目名	項目内容	関連フィルタ
ID	更新するユーザのユーザID	(none)
user_pass	プレーンテキストパスワード	pre_user_pass
user_login	ログインするためのユーザーのユーザー名を含む文字列。WordPressはユーザー名を変更することはできませんので、関数はこのフィールドを変更することはできない点に、ご注意ください。	pre_user_login
user_nicename	URLに含まれる文字列。デフォルトは'user_login'の値	pre_user_nicename
user_url	WebサイトのURL	pre_user_url
user_email	メールアドレス	pre_user_email
display_name	サイトに表示される文字列。デフォルトは'user_login'の値	pre_user_display_name
nickname	ニックネーム。デフォルトは'user_login'の値	pre_user_nickname
first_name	名	pre_user_first_name
last_name	姓	pre_user_last_name
description	ユーザに関する説明	pre_user_description
rich_editing	リッチエディタ使用の有効・無効を設定。空でない場合はFalse	(none)
user_registered	ユーザ情報の登録日時（形式：Y-m-d H:i:s）	(none)
role	ユーザ権限を設定するための文字列	(none)
jabber	Jabber アカウント	(none)
aim	AOL IM アカウント	(none)
yim	Yahoo IM アカウント	(none)
show_admin_bar_front	フロントエンドに管理バーを表示する	(none)

注意: user_pass は WordPress により自動的にハッシュ化されるため、プレーンテキストである必要があります。

注意: user_pass を更新するとユーザーへ通知メールが送られます。

変更履歴

• 3.5.0: stdClass または WP_User オブジェクトを受け取るようになりました。
• 2.0.0: 新規導入

ソースファイル

wp_update_user() は wp-includes/user.php にあります。

関連項目

wp_update_user(), wp_create_user()
カレントユーザー関数: get_current_user_id()/ en, get_currentuserinfo(), wp_get_current_user()/ en, wp_set_current_user(), current_user_can(), current_user_can_for_blog()/ en , get_user_meta() /en

関数リファレンス、テンプレートタグ目次もご覧ください。

最新英語版： WordPress Codex » Function_Reference/wp_update_user （最新版との差分）