• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

「関数リファレンス/wp update user」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(解説: 訳とリンク)
()
67行目: 67行目:
 
以下は内部で使用している関数です。
 
以下は内部で使用している関数です。
  
* Uses: [[関数リファレンス/get_userdata|<tt>get_userdata()</tt>]]
+
* Uses: [[関数リファレンス/get_userdata|<tt>get_userdata()</tt>]] /[[:en:Function_Reference/get_userdata|<tt>en</tt>]] - 渡されたIDからユーザーに紐づく情報のオブジェクトを返します。
* Uses: [[関数リファレンス/wp_hash_password|<tt>wp_hash_password()</tt>]]
+
* Uses: [[関数リファレンス/wp_hash_password|<tt>wp_hash_password()</tt>]] /[[:en:Function_Reference/wp_hash_password|<tt>en</tt>]]
* Uses: [[関数リファレンス/wp_insert_user|<tt>wp_insert_user()</tt>]] ユーザーを更新したり、存在しない場合に作成するために使われます。
+
* Uses: [[関数リファレンス/wp_insert_user|<tt>wp_insert_user()</tt>]] /[[:en:Function_Reference/wp_insert_user|<tt>en</tt>]]  - ユーザーを更新したり、存在しない場合に作成するために使われます。
* Uses: [[関数リファレンス/wp_get_current_user|<tt>wp_get_current_user()</tt>]]
+
* Uses: [[関数リファレンス/wp_get_current_user|<tt>wp_get_current_user()</tt>]] /[[:en:Function_Reference/wp_get_current_user|<tt>en</tt>]]
* Uses: [[関数リファレンス/wp_clear_auth_cookie|<tt>wp_clear_auth_cookie()</tt>]]
+
* Uses: [[関数リファレンス/wp_clear_auth_cookie|<tt>wp_clear_auth_cookie()</tt>]] /[[:en:Function_Reference/wp_clear_auth_cookie|<tt>en</tt>]]
* Uses: [[関数リファレンス/wp_set_auth_cookie|<tt>wp_set_auth_cookie()</tt>]]
+
* Uses: [[関数リファレンス/wp_set_auth_cookie|<tt>wp_set_auth_cookie()</tt>]] /[[:en:Function_Reference/wp_set_auth_cookie|<tt>en</tt>]]
  
  
91行目: 91行目:
 
|-valign="top"
 
|-valign="top"
 
| style="font-weight:bold" | user_login
 
| style="font-weight:bold" | user_login
| A string that contains the user's username for logging in. Please note that the function cannot alter this field, since WordPress does not allow usernames to be changed.
+
| ログインするためのユーザーのユーザー名を含む文字列。WordPressはユーザー名を変更することはできませんので、関数はこのフィールドを変更することはできない点に、ご注意ください。
 
| <tt>pre_user_login</tt>
 
| <tt>pre_user_login</tt>
 
|-valign="top"
 
|-valign="top"

2015年6月20日 (土) 15:54時点における版

このページ「関数リファレンス/wp update user」は未翻訳です。和訳や日本語情報を加筆してくださる協力者を求めています

データベースのユーザーを更新します。

この関数は、データベース内の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!
}		


以下は内部で使用している関数です。


$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により自動的にハッシュ化されるため、プレーンテキストである必要があります。


改訂履歴

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最新版との差分