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

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

関数リファレンス/update metadata

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

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

指定されたオブジェクトのメタデータを更新します。もし指定されたキーのメタデータがそのオブジェクトになければ、メタデータを追加します。

使い方

<?php update_metadata ( $meta_type, $object_id, $meta_key, $meta_value, $prev_value ) ?>

パラメータ

$meta_type
文字列) (必須) メタデータがついたオブジェクトの種類(例えばコメントなら 'comment'、投稿なら 'post'、ユーザーなら 'user')。
初期値: なし
$object_id
整数) (必須) メタデータがついたオブジェクトの ID。
初期値: なし
$meta_key
文字列) (必須) メタデータのキー。これは生の値でなければならない(データベースクエリ時は無害化される)。
初期値: なし
$meta_value
文字列) (必須) メタデータの値。これは生の値でなければならない(データベースクエリ時は無害化される)。スカラー値でないときはシリアル化しなければならない。
初期値: なし
$prev_value
文字列) (オプション) 指定するとその値を持つメタデータのエントリーだけを更新する。指定しなければ全てのエントリーを更新する。
初期値: ''

戻り値

(真偽値) 
更新に成功すると true、失敗すると false。

参考

  • 値を更新する前に 'update_{$meta_type}_meta' アクションを呼び出します。引数は更新するメタデータのエントリーの meta_id$object_id$meta_value です。
  • 値を更新した後に 'updated_{$meta_type}_meta' アクションを呼び出します。引数は更新されたメタデータのエントリーの meta_id$object_id$meta_value です。

変更履歴

新規導入: 2.9

ソースファイル

update_metadata()wp-includes/meta.php にあります。

メタデータ API: add_metadata(), get_metadata() /en, update_metadata() /en, delete_metadata() /en


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


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