add_metadata

説明

int | false add_metadata( string $meta_type, int $object_id, string $meta_key, mixed $meta_value [ , bool $unique = false ] )
WordPressオブジェクトのメタ情報を更新する。

パラメータ

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

返り値

メタ情報を追加できた場合はそのメタ情報IDを返す。それ以外の場合はfalseを返す。

注意

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

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

パラメータ$uniquetrueで既存のメタ情報が存在する場合はすぐに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 );

フィルター

[3.1.0]メタ情報の追加する前に"add_{$meta_type}_metadata"フィルターを呼び出す。パラメータ$checkにはnullが、$object_idには絶対値処理されたオブジェクトIDが、$meta_key$uniqueには本関数が受け取った内容が、$meta_valueにはサニタイズした内容が格納されている。
$check = apply_filters( "add_{$meta_type}_metadata", $check, $object_id, $meta_key, $meta_value, $unique );

アクション

[2.9.0]メタ情報を追加する前に"add_{$meta_type}_meta"アクションを呼び出す。パラメータ$object_idには絶対値処理されたオブジェクトIDが、$meta_keyには本関数が受け取った内容が、$_meta_valueにはシリアライズされていない値が格納されている。
do_action( "add_{$meta_type}_meta", $object_id, $meta_key, $_meta_value );
[2.9.0]メタ情報を追加した後に"added_{$meta_type}_meta"アクションを呼び出す。パラメータ$meta_idにはメタ情報IDが、$object_idには絶対値処理されたオブジェクトIDが、$meta_keyには本関数が受け取った内容が、$_meta_valueにはシリアライズされていない値が格納されている。
do_action( "added_{$meta_type}_meta", $meta_id, $object_id, $meta_key, $_meta_value );

ソースファイル

/wp-includes/meta.php

最終更新 : 2024年06月25日 17:06



お勧め

CSSやJavaScriptファイルのバージョン番号を変える(2018年5月27日 更新)

WordPress 4.7系の脆弱性をついた攻撃も落ち着いた感じなので、標準でヘッダーやフッター内に出力されるWordPressのバージョン番号について一考しました。

テーブルブロックを投稿メタ(カスタムフィールド)に保存する(2022年1月5日 更新)

ふと「テーブルブロックの内容を投稿メタ(カスタムフィールド)として保存できたら便利なのでは」と思い、投稿メタの使い方を調べてみた。

カスタム投稿タイプの投稿保存には専用アクションを使おう(2014年7月4日 更新)

カスタム投稿タイプを登録して、専用ウィジェット(meta_box)を使って拡張情報を入力させ、それらの情報をsave_postアクションで保存する。これまではこんな感じだったのだが、久しぶりにカスタム投稿タイプを使ったら、save_postアクションの前にsave_postに投稿タイプ名がくっついたアクションが追加されていた。

Fotepo:プラグイン作ってみました(2019年9月19日 更新)

仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。

5.3への準備:投稿写真を使っているサイトは準備しておこう(2019年10月10日 更新)

この記事は先日公開した「5.3の新機能:JPEG画像の向きを調整」の続きのようなものになる。高解像度の投稿写真を扱っているサイトは、5.3のリリースに合わせて対応を検討しておくべきことをまとめてみた。