- 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。（詳細）
「関数リファレンス/wp update user」の版間の差分
細 (訳終わり) |
細 (→関連情報: {{Tag Footer}}) |
||
| 179行目: | 179行目: | ||
{{Current User Tags}} | {{Current User Tags}} | ||
| + | {{Tag Footer}} | ||
<!-- | <!-- | ||
To Do: | To Do: | ||
2015年6月20日 (土) 15:55時点における版
データベースのユーザーを更新します。
この関数は、データベース内の1つのユーザーを更新します。このアップデートでは、配列としてユーザメタデータの複数の部分を含めることができます。
ユーザメタ情報の一部を更新する場合は、代わりに update_user_meta() /en を使用してください。
新規ユーザを作成する場合は、代わりに wp_insert_user() /en を使用してください。
注: 現在ログインしているユーザのパスワードが更新された場合、Cookieはクリアされます。
特記事項
If $userdata does not contain an 'ID' key, then a new user will be created and the new user's ID will be returned.
バージョン3.6以来、このようなことはありませんが、この動作は、将来的に復元することもできる。チケットticket #16731を参照してください。
使い方
<?php wp_update_user( $userdata ) ?>
パラメータ
- $userdata
- （配列｜オブジェクト） （必須） ユーザー情報の配列または stdClass、またはWP_User オブジェクト。
- 初期値： なし
戻り値
- (整数｜オブジェクト)
- 更新に成功するとユーザ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 ) ) {
// There was an error, probably that user doesn't exist.
} else {
// Success!
}
注
以下は内部で使用している関数です。
- Uses: get_userdata() /en - 渡されたIDからユーザーに紐づく情報のオブジェクトを返します。
- Uses: wp_hash_password() /en
- Uses: wp_insert_user() /en - ユーザーを更新したり、存在しない場合に作成するために使われます。
- Uses: wp_get_current_user() /en
- Uses: wp_clear_auth_cookie() /en
- Uses: wp_set_auth_cookie() /en
| 項目名 | 項目内容 | 関連フィルタ |
|---|---|---|
| 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により自動的にハッシュ化されるため、プレーンテキストである必要があります。
改訂履歴
2.0.0: 導入されました。 3.5.0: stdClassまたはWP_Userオブジェクトを受け取ります。
ソースファイル
wp_update_user()はwp-includes/registration.phpにあります。
関連情報
カレントユーザー関数: 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
最新英語版： WordPress Codex » Function_Reference/wp_update_user （最新版との差分）
