当サイト、Codex 日本語版は今後積極的な更新は行わない予定です。後継となる新ユーザーマニュアルは、https://ja.wordpress.org/support/ にあります。
万が一、当サイトで重大な問題を発見した際などは、フォーラムWordSlack #docs チャンネルでお知らせください。</p>

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

提供: WordPress Codex 日本語版
移動先: 案内検索
(en:Function Reference/update_user_meta 19:05, 28 May 2015 Figureone 版を流し込み。)
 
(和訳完了。)
 
1行目: 1行目:
{{NeedTrans}}
+
{{CheckTrans}}
  
 
== 説明<span id="Description"></span> ==
 
== 説明<span id="Description"></span> ==
  
Update user meta field based on user ID.
+
ユーザー ID を指定してユーザーメタデータを更新します。
  
Use the <tt>$prev_value</tt> parameter to differentiate between meta fields with the same key and user ID.
+
同じキーとユーザー ID を持つ複数のメタデータを区別するには <tt>$prev_value</tt> パラメータを使ってください。
  
If the meta field for the user does not exist, it will be added.
+
ユーザーが指定したメタデータを持たなければ、追加されます。
  
 
== 使い方<span id="Usage"></span> ==
 
== 使い方<span id="Usage"></span> ==
15行目: 15行目:
 
== パラメータ<span id="Parameters"></span> ==
 
== パラメータ<span id="Parameters"></span> ==
  
{{Parameter|$user_id|integer|User ID.}}
+
{{Parameter|$user_id|整数|ユーザー ID。}}
{{Parameter|$meta_key|string|The meta_key in the wp_usermeta table for the meta_value to be updated.|required}}
+
{{Parameter|$meta_key|文字列|値(meta_value)を更新するメタデータの名前(wp_usermeta テーブルの meta_key)。|必須}}
{{Parameter|$meta_value|mixed|The new desired value of the meta_key, which must be different from the existing value. Arrays and objects will be automatically serialized. '''Note that using objects may cause [http://core.trac.wordpress.org/ticket/9640 this bug] to popup'''.|required}}
+
{{Parameter|$meta_value|mixed|$meta_key で指定したメタデータの新しい値。現在の値とは異なっていなければならない。配列とオブジェクトは自動的にシリアル化される。'''オブジェクトを使うと [http://core.trac.wordpress.org/ticket/9640 このバグ] を顕在化させてしまうかもしれない'''|必須}}
{{Parameter|$prev_value|mixed|Previous value to check before removing.|optional|&#39;&#39;}}
+
{{Parameter|$prev_value|mixed|現在の値がこれであることを確かめてからメタデータを更新する。|オプション|&#39;&#39;}}
  
 
== 戻り値<span id="Return Values"></span> ==
 
== 戻り値<span id="Return Values"></span> ==
  
{{Return||int/boolean|Meta ID if the key didn't exist; true on successful update; false on failure or if $meta_value is the same as the existing meta value in the database.}}
+
{{Return||整数/真偽値|名前(<tt>$meta_key</tt>)が存在しなければメタデータの ID を返す。更新が成功すれば true を返す。更新に失敗するか、$meta_value がデータベース内のメタデータ値と同じなら false を返す。}}
  
 
== 用例<span id="Examples"></span> ==
 
== 用例<span id="Examples"></span> ==
  
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';
update_user_meta($user_id, 'user_url', $website);
+
update_user_meta( $user_id, 'user_url', $website );
 
?>
 
?>
 
</pre>
 
</pre>
  
Below is an example showing how to check for errors:
+
次の例はエラーのチェック方法を示します:
 
<pre>
 
<pre>
 +
<?php
 
$user_id = 1;
 
$user_id = 1;
 
$new_value = 'some new value';
 
$new_value = 'some new value';
 
+
// will return false if the previous value is the same as $new_value
+
// 現在の値が $new_value と同じなら false を返す。
update_user_meta( $user_id, 'some_meta_key', $new_value );
+
$updated = update_user_meta( $user_id, 'some_meta_key', $new_value );
 
+
// so check and make sure the stored value matches $new_value
+
// そこで、保存された値が $new_value と一致するか確かめる。
if ( get_user_meta($user_id,  'some_meta_key', true ) != $new_value )
+
if ( $new_value != get_user_meta( $user_id,  'some_meta_key', true ) ) {
wp_die('An error occurred');
+
    wp_die( __( 'An error occurred', 'textdomain' ) );
 +
}
 
?>
 
?>
 
</pre>
 
</pre>
51行目: 53行目:
 
== 参考<span id="Notes"></span> ==
 
== 参考<span id="Notes"></span> ==
  
* Uses: [[関数リファレンス/update_metadata|<tt>update_metadata()</tt>]]
+
* 内部で [[関数リファレンス/update_metadata|<tt>update_metadata()</tt>]] を使います。
  
Changes in behavior from the now deprecated [https://developer.wordpress.org/reference/functions/update_usermeta/ <tt>update_usermeta()</tt>]:
+
廃止された [https://developer.wordpress.org/reference/functions/update_usermeta/ <tt>update_usermeta()</tt>] とは以下の点で動作が異なります:
* update_user_meta does not delete the meta if the new value is empty.
+
* update_user_meta() は新しい値が空でもメタデータを削除しません。
* The actions are different.
+
* 呼び出されるアクションが異なります。
  
 
== 変更履歴<span id="Change_Log"></span> ==
 
== 変更履歴<span id="Change_Log"></span> ==
  
Since: 3.0.0
+
新規導入: 3.0.0
  
 
== ソースファイル<span id="Source_File"></span> ==
 
== ソースファイル<span id="Source_File"></span> ==
  
<tt>update_user_meta()</tt> is located in {{Trac|wp-includes/user.php}}.
+
<tt>update_user_meta()</tt> {{Trac|wp-includes/user.php}} にあります。
  
 
== 関連項目<span id="Related"></span> ==
 
== 関連項目<span id="Related"></span> ==

2017年5月10日 (水) 23:51時点における最新版

この項目「関数リファレンス/update user meta」は、翻訳チェック待ちの項目です。加筆、訂正などを通して、Codex ドキュメンテーションにご協力下さい。

説明

ユーザー ID を指定してユーザーメタデータを更新します。

同じキーとユーザー ID を持つ複数のメタデータを区別するには $prev_value パラメータを使ってください。

ユーザーが指定したメタデータを持たなければ、追加されます。

使い方

<?php update_user_meta( $user_id, $meta_key, $meta_value, $prev_value ); ?>

パラメータ

$user_id
整数) (必須) ユーザー ID。
初期値: なし
$meta_key
文字列) (必須) 値(meta_value)を更新するメタデータの名前(wp_usermeta テーブルの meta_key)。
初期値: なし
$meta_value
mixed) (必須) $meta_key で指定したメタデータの新しい値。現在の値とは異なっていなければならない。配列とオブジェクトは自動的にシリアル化される。オブジェクトを使うと このバグ を顕在化させてしまうかもしれない
初期値: なし
$prev_value
mixed) (オプション) 現在の値がこれであることを確かめてからメタデータを更新する。
初期値: ''

戻り値

(整数/真偽値) 
名前($meta_key)が存在しなければメタデータの ID を返す。更新が成功すれば true を返す。更新に失敗するか、$meta_value がデータベース内のメタデータ値と同じなら false を返す。

用例

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

<?php
$user_id = 1;
$website = 'http://wordpress.org';
update_user_meta( $user_id, 'user_url', $website );
?>

次の例はエラーのチェック方法を示します:

<?php
$user_id = 1;
$new_value = 'some new value';
 
// 現在の値が $new_value と同じなら false を返す。
$updated = update_user_meta( $user_id, 'some_meta_key', $new_value );
 
// そこで、保存された値が $new_value と一致するか確かめる。
if ( $new_value != get_user_meta( $user_id,  'some_meta_key', true ) ) {
    wp_die( __( 'An error occurred', 'textdomain' ) );
}
?>

参考

廃止された update_usermeta() とは以下の点で動作が異なります:

  • update_user_meta() は新しい値が空でもメタデータを削除しません。
  • 呼び出されるアクションが異なります。

変更履歴

新規導入: 3.0.0

ソースファイル

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

関連項目

add_user_meta(), delete_user_meta(), get_user_meta(), update_user_meta(), get_user_option() /en, delete_user_option() /en, update_user_option() /en,


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


最新英語版: WordPress Codex » Function_Reference/update_user_meta最新版との差分