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

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

提供: WordPress Codex 日本語版
< 関数リファレンス
2017年5月5日 (金) 16:50時点におけるGblsm (トーク | 投稿記録)による版 (en:Function Reference/update_user_meta 19:05, 28 May 2015 Figureone 版を流し込み。)

(差分) ← 古い版 | 最新版 (差分) | 新しい版 → (差分)
移動先: 案内検索

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

説明

Update user meta field based on user ID.

Use the $prev_value parameter to differentiate between meta fields with the same key and user ID.

If the meta field for the user does not exist, it will be added.

使い方

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

パラメータ

$user_id
integer) (必須) User ID.
初期値: なし
$meta_key
string) (required) The meta_key in the wp_usermeta table for the meta_value to be updated.
初期値: なし
$meta_value
mixed) (required) 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 this bug to popup.
初期値: なし
$prev_value
mixed) (optional) Previous value to check before removing.
初期値: ''

戻り値

(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.

用例

Below is an example showing how to update a user's Website profile field

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

Below is an example showing how to check for errors:

$user_id = 1;
$new_value = 'some new value';

// will return false if the previous value is the same as $new_value
update_user_meta( $user_id, 'some_meta_key', $new_value );

// so check and make sure the stored value matches $new_value
if ( get_user_meta($user_id,  'some_meta_key', true ) != $new_value )
	wp_die('An error occurred');
?>

参考

Changes in behavior from the now deprecated update_usermeta():

  • update_user_meta does not delete the meta if the new value is empty.
  • The actions are different.

変更履歴

Since: 3.0.0

ソースファイル

update_user_meta() is located in 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最新版との差分