add_metadata

（2.9.0以降）
add_metadata - WordPressオブジェクトのメタ情報を追加する

説明

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以外を返した場合は、以降の処理は行われず、本関数の返り値となる。

パラメータ$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 );

フィルター

[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

関連

参考

Code Reference: add_metadata

お勧め

カテゴリー専用の投稿一覧と新規投稿メニューを追加する（2012年1月23日 更新）

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。

ブロックエディターの文字サイズ設定を変えてみる（2019年12月12日 更新）

今回は「前回投稿した内容」の続きブロックエディターの文字サイズ設定を変えようと思う。参考にするテーマはもちろん「Twenty Twenty」である。

4.2で始まるiOSの絵文字ケア（2018年5月27日 更新）

WordPress 4.2のベータ1、ベータ2が立て続けにリリースされ、4.2の正式版リリースが近づいています。4.2のポイントの1つは絵文字のクロスブラウザ対応です。ここでの絵文字とは、UTF-8で4バイトのコードが割り当てられている（基本的にはiOSの）絵文字を指します。この絵文字を含んだ投稿が正しく保存できなかったり、iOS以外の環境で意図した通りに表示できないといった問題があり、4.2ではそのような問題を対処をコードが組み込まれています。

「不明な書式」って何ですか。（2024年11月13日 更新）

オートコンプリート機能を利用して四字熟語を挿入するプラグインを作った際、ツールバーに「不明な書式をクリア（Clear Unknown Formatting）」ボタンが表示されるようになった。この「書式」、何を指しているのかわからないんだが。

決まった値を返すだけの関数群（2018年5月27日 更新）

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。