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

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

関数リファレンス/add metadata

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

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

WordPress 内の指定されたオブジェクトへメタデータを追加します。

: これは汎用でローレベルの関数であり、プラグインやテーマにより直接使用することは避けてください。 その代わりに、作業しているオブジェクトタイプに対応するメタ関数を使用してください。

使い方

<?php add_metadata( $meta_type, $object_id, $meta_key, $meta_value, $unique ); ?>

パラメータ

$meta_type
文字列) (必須) メタデータをつけるオブジェクトの種類(例えば、コメントなら 'comment'、投稿なら 'post'、ユーザーなら 'user')。常に単数形。
初期値: なし
$object_id
整数) (必須) メタデータをつけるオブジェクトの ID。
初期値: なし
$meta_key
文字列) (必須) メタデータのキー('キー' => '値' として)。
初期値: なし
$meta_value
文字列) (必須) メタデータの値('キー' => '値' として)。スカラー値でないときはシリアル化しなければならない。
初期値: なし
$unique
真偽値) (オプション) 指定された ID のオブジェクトについて、このキーを持つメタデータがユニークであるかどうか。true の場合、指定された ID のオブジェクトに同じキーのメタデータが既にあれば追加しない。false の場合、同じキーで複数追加する。
初期値: false

戻り値

(真偽値|整数) 
失敗すると false を返します。成功すると、挿入された行(メタデータ)の ID を返します。ただし、戻り値は 'add_{$meta_type}_metadata' フィルターの結果になる場合があります。

参考

  • $wpdb /en を使用します。
  • apply_filters() を使って 'add_{$meta_type}_metadata' フィルターを呼び出します。引数は null と、この関数へ渡されたパラメータです。そしてフィルターの戻り値が null でなければ、この関数はそれ以上なにもせずに、その値を返します。
  • メタデータの追加に成功すると、do_action() を使って 'added_{$meta_type}_meta' アクションを呼び出します。パラメータは meta テーブルの新しい行の ID と、この関数のパラメータの先頭から 3 つです。

変更履歴

ソースファイル

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

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



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


最新英語版: WordPress Codex » Function Reference/add_metadata最新版との差分