説明
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 );do_action( "added_{$meta_type}_meta", $meta_id, $object_id, $meta_key, $_meta_value );ソースファイル
/wp-includes/meta.php最終更新 : 2024年06月25日 17:06
関連
お勧め
meta_compare_key使ってみた（2019年3月19日 更新）
ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名（メタキー）に含まれる文字列を指定する'meta_compare_key'キーだ。
WP_List_Tableクラスの「一括操作」フォームを使ってみた（2018年5月27日 更新）
今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」（Bulkアクション）フォーム対応に関するメモである。
テーマから投稿画像のサイズを指定する（2012年3月15日 更新）
投稿記事に挿入する画像サイズは、サムネイル（150×150）、中サイズ（300×300）、大サイズ（1024×1024）がデフォルトだが、テーマによっては別のサイズを指定したい場合はある。基本的には、「設定」－「メディア」の「メディア設定」ページで指定できるが、テーマ内のfunctions.phpで設定しておくとちょっと便利かもしれない。ログインページを変える（2014年9月12日 更新）
WordPressの標準的な不正ログイン対策としては、ログインIDは'admin'を避けるパスワードはユニークで長くする、場合によってはアクセスできるIPアドレスを制限する、といった具合だろう。これらの他に何かできないものだろうかと、ちょっと考えてみた。新規投稿時の本文プレースホルダーテキストを変える（2021年9月9日 更新）
ブロックエディターに影響を与えるフィルターは多数存在する。今回紹介するフィルターはその1つで、新規投稿時の本文ブロックのプレースホルダーテキストを変更するものだ。