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

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

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

提供: WordPress Codex 日本語版
移動先: 案内検索

この項目「関数リファレンス/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最新版との差分