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

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

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

提供: WordPress Codex 日本語版
移動先: 案内検索
(改訂履歴: 最新のマージ)
 
(3人の利用者による、間の14版が非表示)
1行目: 1行目:
<div id="Description">
+
== 説明<span id="Description"></span> ==
== 解説 ==
+
</div>
+
データベースのユーザーを更新(または作成)します。
+
  
パラメータ<tt>$userdata</tt>の配列に'user_pass'の値を設定することで、ユーザーのパスワードを更新できます。
+
この関数はデータベース内の1件のユーザー情報を更新します。更新情報には配列としてユーザーメタ情報の複数の項目を含めることができますが、カスタムユーザーメタフィールドは更新しません。この関数が更新できるメタ情報は [[関数リファレンス/wp_insert_user|wp_insert_user()]] /[[:en:Function_Reference/wp_insert_user|en]] と同じです。
  
もし<tt>$userdata</tt>がキー'ID'を含まなければ、新しいユーザーが作成され、作成されたユーザーのIDが返ってきます。
+
ユーザーメタ情報の項目1つを更新するには、[[関数リファレンス/update_user_meta|update_user_meta()]] /[[:en:Function_Reference/update_user_meta|en]] を代わりに使ってください。
  
現在のユーザーのパスワードが更新された場合は、Cookieが削除されます。
+
''新規''ユーザーを作成したり、パスワード変更メールを送らずに更新したりするには、[[関数リファレンス/wp_insert_user|wp_insert_user()]] /[[:en:Function_Reference/wp_insert_user|en]] を代わりに使ってください。
  
<div id="Usage">
+
'''参考:''' 現在ログインしているユーザーのパスワードが更新されると、Cookie はクリアされます!
== 使用法 ==
+
</div>
+
<pre>
+
&lt;?php wp_update_user( $userdata ) ?&gt;
+
</pre>
+
  
<div id="Parameters">
+
=== 特記事項<span id="Special Note"></span> ===
== パラメータ ==
+
</div>
+
{{Parameter|$userdata|array|ユーザーデータの配列}}
+
  
<div id="Return_Values">
+
<del>(バージョン3.6より前は) <tt>$userdata</tt> がキー 'ID' を含まなければ、新規ユーザーが作られてそのユーザー ID が返されます。</del> バージョン3.6以降、このようなことはありませんが、この動作は将来復活するかもしれません。[https://core.trac.wordpress.org/ticket/16731 チケット #16731] を見てください。
== 戻り値 ==
+
 
</div>
+
== 使い方<span id="Usage"></span> ==
; <tt>(integer)</tt> : 更新されたユーザーのID。
+
 
 +
<?php wp_update_user( $userdata ) ?>
 +
 
 +
== パラメータ<span id="Parameters"></span> ==
 +
 
 +
{{Parameter|$userdata|mixed|ユーザー情報の配列、stdClass、[[クラスリファレンス/WP_User|WP_User]] オブジェクトのいずれか。}}
 +
 
 +
== 戻り値<span id="Return Values"></span> ==
 +
 
 +
; <tt>(mixed)</tt> : 成功するとユーザー ID を、それ以外の場合は [[クラスリファレンス/WP_Error|WP_Error]] オブジェクトを返します。
 +
 
 +
== 用例<span id="Examples"></span> ==
 +
 
 +
以下の例はユーザープロフィールの項目「ウェブサイト」を更新する方法を示します:
  
<div id="Examples">
 
== 使用例 ==
 
</div>
 
<!-- Need creative examples. Feel free to link to external examples. -->
 
Below is an example showing how to update a user's Website profile field
 
 
<pre>
 
<pre>
 
<?php
 
<?php
 
$user_id = 1;
 
$user_id = 1;
 
$website = 'http://wordpress.org';
 
$website = 'http://wordpress.org';
wp_update_user( array ('ID' => $user_id, 'user_url' => $website) ) ;
+
 
?>
+
$user_id = wp_update_user( array( 'ID' => $user_id, 'user_url' => $website ) );
 +
 
 +
if ( is_wp_error( $user_id ) ) {
 +
// エラー発生、おそらくユーザーが存在しなかった。
 +
} else {
 +
// 成功!
 +
}
 
</pre>
 
</pre>
  
<div id="Notes">
+
== 参考<span id="Notes"></span> ==
== 注 ==
+
</div>
+
以下は内部で使用している関数です。
+
  
* Uses: [[関数リファレンス/get_userdata|<tt>get_userdata()</tt>]]
+
=== 内部で使用する関数 ===
* Uses: [[関数リファレンス/wp_hash_password|<tt>wp_hash_password()</tt>]]
+
* Uses: [[関数リファレンス/wp_insert_user|<tt>wp_insert_user()</tt>]] ユーザーを更新したり、存在しない場合に作成するために使われます。
+
* Uses: [[関数リファレンス/wp_get_current_user|<tt>wp_get_current_user()</tt>]]
+
* Uses: [[関数リファレンス/wp_clear_auth_cookie|<tt>wp_clear_auth_cookie()</tt>]]
+
* Uses: [[関数リファレンス/wp_set_auth_cookie|<tt>wp_set_auth_cookie()</tt>]]
+
  
 +
* [[関数リファレンス/get_userdata|<tt>get_userdata()</tt>]] - 渡された ID からユーザーに紐づく情報のオブジェクトを返します。
 +
* [[関数リファレンス/wp_hash_password|<tt>wp_hash_password()</tt>]] /[[:en:Function_Reference/wp_hash_password|<tt>en</tt>]]
 +
* [[関数リファレンス/wp_insert_user|<tt>wp_insert_user()</tt>]] /[[:en:Function_Reference/wp_insert_user|<tt>en</tt>]] - ユーザーを更新したり、存在しない場合に作成するために使われます。
 +
* [[関数リファレンス/wp_get_current_user|<tt>wp_get_current_user()</tt>]] /[[:en:Function_Reference/wp_get_current_user|<tt>en</tt>]]
 +
* [[関数リファレンス/wp_clear_auth_cookie|<tt>wp_clear_auth_cookie()</tt>]] /[[:en:Function_Reference/wp_clear_auth_cookie|<tt>en</tt>]]
 +
* [[関数リファレンス/wp_set_auth_cookie|<tt>wp_set_auth_cookie()</tt>]] /[[:en:Function_Reference/wp_set_auth_cookie|<tt>en</tt>]]
 +
 +
=== 引数の詳細 ===
 +
 +
配列 <tt>$userdata</tt> には次の項目を含めることができます。
  
 
{| border="0" cellspacing="5" summary="User data array fields."
 
{| border="0" cellspacing="5" summary="User data array fields."
|+ The <tt>$userdata</tt> array can contain the following fields
 
 
|-
 
|-
! style="font-weight:bold" | Field Name
+
! style="font-weight:bold" | 項目名
! Description
+
! 項目内容
! [[Plugin_API/Filter_Reference#Database_Writes_4|Associated Filter]]
+
! [[プラグイン_API/フィルターフック一覧#.E3.83.87.E3.83.BC.E3.82.BF.E3.83.99.E3.83.BC.E3.82.B9.E6.9B.B8.E3.81.8D.E8.BE.BC.E3.81.BF_4|関連フィルタ]]
 
|-valign="top"
 
|-valign="top"
 
| style="font-weight:bold" | ID
 
| style="font-weight:bold" | ID
| An integer that will be used for updating an existing user.
+
| 更新するユーザのユーザID
 
| (none)
 
| (none)
 
|-valign="top"
 
|-valign="top"
 
| style="font-weight:bold" | user_pass
 
| style="font-weight:bold" | user_pass
| A string that contains the plain text password for the user.
+
| プレーンテキストパスワード
 
| <tt>pre_user_pass</tt>
 
| <tt>pre_user_pass</tt>
 
|-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"
 
| style="font-weight:bold" | user_nicename
 
| style="font-weight:bold" | user_nicename
| A string that contains a URL-friendly name for the user. The default is the user's username.
+
| URLに含まれる文字列。デフォルトは'user_login'の値
 
| <tt>pre_user_nicename</tt>
 
| <tt>pre_user_nicename</tt>
 
|-valign="top"
 
|-valign="top"
 
| style="font-weight:bold" | user_url
 
| style="font-weight:bold" | user_url
| A string containing the user's URL for the user's web site.
+
| WebサイトのURL
 
| <tt>pre_user_url</tt>
 
| <tt>pre_user_url</tt>
 
|-valign="top"
 
|-valign="top"
 
| style="font-weight:bold" | user_email
 
| style="font-weight:bold" | user_email
| A string containing the user's email address.
+
| メールアドレス
 
| <tt>pre_user_email</tt>
 
| <tt>pre_user_email</tt>
 
|-valign="top"
 
|-valign="top"
 
| style="font-weight:bold" | display_name
 
| style="font-weight:bold" | display_name
| A string that will be shown on the site. Defaults to user's username. It is likely that you will want to change this, for both appearance and security through obscurity (that is if you dont use and delete the default admin user).
+
| サイトに表示される文字列。デフォルトは'user_login'の値
 
| <tt>pre_user_display_name</tt>
 
| <tt>pre_user_display_name</tt>
 
|-valign="top"
 
|-valign="top"
 
| style="font-weight:bold" | nickname
 
| style="font-weight:bold" | nickname
| The user's nickname, defaults to the user's username.
+
| ニックネーム。デフォルトは'user_login'の値
 
| <tt>pre_user_nickname</tt>
 
| <tt>pre_user_nickname</tt>
 
|-valign="top"
 
|-valign="top"
 
| style="font-weight:bold" | first_name
 
| style="font-weight:bold" | first_name
| The user's first name.
+
|
 
| <tt>pre_user_first_name</tt>
 
| <tt>pre_user_first_name</tt>
 
|-valign="top"
 
|-valign="top"
 
| style="font-weight:bold" | last_name
 
| style="font-weight:bold" | last_name
| The user's last name.
+
|
 
| <tt>pre_user_last_name</tt>
 
| <tt>pre_user_last_name</tt>
 
|-valign="top"
 
|-valign="top"
 
| style="font-weight:bold" | description
 
| style="font-weight:bold" | description
| A string containing content about the user.
+
| ユーザに関する説明
 
| <tt>pre_user_description</tt>
 
| <tt>pre_user_description</tt>
 
|-valign="top"
 
|-valign="top"
 
| style="font-weight:bold" | rich_editing
 
| style="font-weight:bold" | rich_editing
| A string for whether to enable the rich editor or not. False if not empty.
+
| リッチエディタ使用の有効・無効を設定。空でない場合はFalse
 
| (none)
 
| (none)
 
|-valign="top"
 
|-valign="top"
 
| style="font-weight:bold" | user_registered
 
| style="font-weight:bold" | user_registered
| The date the user registered. Format is Y-m-d H:i:s.
+
| ユーザ情報の登録日時(形式:Y-m-d H:i:s)
 
| (none)
 
| (none)
 
|-valign="top"
 
|-valign="top"
 
| style="font-weight:bold" | role
 
| style="font-weight:bold" | role
| A string used to set the user's role.
+
| ユーザ権限を設定するための文字列
 
| (none)
 
| (none)
 
|-valign="top"
 
|-valign="top"
 
| style="font-weight:bold" | jabber
 
| style="font-weight:bold" | jabber
| User's Jabber account.
+
| Jabber アカウント
 
| (none)
 
| (none)
 
|-valign="top"
 
|-valign="top"
 
| style="font-weight:bold" | aim
 
| style="font-weight:bold" | aim
| User's AOL IM account.
+
| AOL IM アカウント
 
| (none)
 
| (none)
 
|-valign="top"
 
|-valign="top"
 
| style="font-weight:bold" | yim
 
| style="font-weight:bold" | yim
| User's Yahoo IM account.
+
| Yahoo IM アカウント
 
| (none)
 
| (none)
 
|-valign="top"
 
|-valign="top"
 
| style="font-weight:bold" | show_admin_bar_front
 
| style="font-weight:bold" | show_admin_bar_front
| Show the WP admin bar on the front-end.
+
| フロントエンドに管理バーを表示する
 
| (none)
 
| (none)
 
|}
 
|}
  
Remember, <tt>user_pass</tt> should be the plain text password as it will be automatically hashed by WordPress.
+
'''注意:''' <tt>user_pass</tt> WordPress により自動的にハッシュ化されるため、プレーンテキストである必要があります。
  
 +
'''注意:''' <tt>user_pass</tt> を更新するとユーザーへ通知メールが送られます。
  
 +
== 変更履歴<span id="Change_Log"></span> ==
  
<div id="Change_Log">
+
* [[Version_3.5|3.5.0]]: stdClass または [[クラスリファレンス/WP_User|WP_User]] オブジェクトを受け取るようになりました。
 +
* [[Version 2.0|2.0.0]]: 新規導入
  
== 改訂履歴 ==
+
== ソースファイル<span id="Source_File"></span> ==
</div>
+
2.0.0: 導入されました。
+
3.5.0: stdClassまたはWP_Userオブジェクトを受け取ります。
+
  
<div id="Source File">
+
<tt>wp_update_user()</tt> は {{Trac|wp-includes/user.php}} にあります。
  
== Source File ==
+
== 関連項目<span id="Related"></span> ==
</div>
+
<!-- Need links to current source code files -->
+
<tt>wp_update_user()</tt>は<tt>wp-includes/registration.php</tt>にあります。
+
  
<div id="Related">
+
[[関数リファレンス/wp_insert_user|wp_insert_user()]], [[関数リファレンス/wp_create_user|wp_create_user()]]<br />
== 関連情報 ==
+
{{Current User Tags}}
</div>
+
, [[関数リファレンス/get_user_meta|get_user_meta()]] /[[:en:Function Reference/get_user_meta|en]]
<!--
+
    To Do:
+
    Need to find related functions.
+
    Need to create groups of functions and create templates to add them to a page quickly.
+
    Some functions may be related to many groups of functions.
+
-->
+
  
{{原文|Function_Reference/wp_update_user|96648}} <!-- 22:15, 19 December 2010‎ SergeyBiryukov  版 -->
+
{{Tag Footer}}
[[Category:関数リファレンス]]
+
 
 +
{{原文|Function_Reference/wp_update_user|158132}} <!-- 21:27, 22 August 2016 Bcole808 版 -->
 +
 
 +
{{DEFAULTSORT:Wp_update_user}}
 
[[Category:関数]]
 
[[Category:関数]]
 
[[Category:wp2.0]]
 
[[Category:wp2.0]]
 
[[Category:wp3.5]]
 
[[Category:wp3.5]]
 +
 +
[[en:Function Reference/wp_update_user]]
 +
[[ko:Function Reference/wp_update_user]]

2017年5月5日 (金) 17:44時点における最新版

説明

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

参考

内部で使用する関数

引数の詳細

配列 $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_insert_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最新版との差分