add_metadata

パラメータ

• $meta_type
  オブジェクトタイプとして'post'、'comment'、'term'、'user'などを指定。
• $object_id
  関連するWordPressオブジェクトのIDを指定。
• $meta_key
  メタキーを指定。
• $meta_value
  メタ情報の値を指定。
• $unique
  キー名のメタ情報が未登時のみ追加する場合はtrueを指定（省略時はfalse）。

返り値

注意

本関数は投稿メタ（カスタムフィールド）やコメントメタなどのメタ情報を追加する場合に使用し、投稿メタを追加する add_post_meta関数や、ユーザーメタを追加する add_user_meta関数などから呼び出される。

[3.1.0]"add_{$meta_type}_metadata"フィルターのコールバック関数にてメタ情報の適切な処理を行い、null以外を返した場合は、以降の処理は行われず、本関数の返り値となる。

パラメータ$uniqueがtrueで既存のメタ情報が存在する場合はすぐにfalseを返し、"add_{$meta_type}_metadata"フィルター以外のフィルター・アクションは実行されない。

メタ情報の追加に失敗した場合、"added_{$meta_type}_meta"アクションは実行されない。

使用例

• メタ情報'access'を追加する

  add_metadata( 'user', $user_id, 'access', time() );

• 未登録時のみメタ情報'inactive'を追加する

  add_metadata( 'user', $user_id, 'inactive', time(), true );

フィルター

$check = apply_filters( "add_{$meta_type}_metadata", $check, $object_id, $meta_key, $meta_value, $unique );

アクション

do_action( "add_{$meta_type}_meta", $object_id, $meta_key, $_meta_value );

do_action( "added_{$meta_type}_meta", $meta_id, $object_id, $meta_key, $_meta_value );

ソースファイル