register_meta

説明

bool register_meta( string $object_type, string $meta_key, array $args [ , string | array $deprecated = null ] )
WordPressオブジェクトのメタ情報を登録する。

パラメータ

  • $object_type
    オブジェクトタイプとして'post'、'comment'、'term'、'user'などを指定。
  • $meta_key
    メタキーを指定。
  • $args
    メタ情報の諸設定を連想配列で指定。主な内容は次の通り。
    キー内容デフォルト値
    'object_subtype'[4.9.8]サブタイプ($object_typeが'post'の場合は'post'や'page'などの投稿タイプ)''
    'type'データタイプ('string'、'boolean'、'integer'、'number'、'array'、'object')'string'
    'description'説明文''
    'default'[5.5.0]デフォルト値''
    'single'1つのメタキーに1つの値を保持する場合はtrue、複数の値を保持する場合はfalseを指定false
    'sanitize_callback'サニタイズを行うコールバック関数を指定null
    'auth_callback'edit_post_meta、 add_post_meta delete_post_meta関数が使用された際に権限を確認するコールバック関数を指定null
    'show_in_rest'REST APIで使用する場合はtrueを指定false
    'revisions_enabled'[6.4.0]リビジョンに対応する場合はtrueを指定($object_typeが'post'の場合のみ有効)false
  • $deprecated
    [4.6.0]非推奨に変更。コールバック関数が指定された場合は$args['auth_callback']に適用される。

返り値

メタ情報を登録できた場合はtrueを返す。登録できなかった場合はfalseを返す。

注意

本関数は投稿メタ(カスタムフィールド)やコメントメタなどのメタ情報を登録する場合に使用する。投稿メタの登録は、 register_post_meta関数が使用できる。

[4.6.0]第3パラメータが連想配列に変わり、第4パラメータが非推奨になった。

[5.3.0]パラメータ$args['type']に'array'と'object'が指定可能になった。


使用例

  • REST APIで使用できるユーザーメタ情報を登録する
    register_meta( 'user', 'picture_id', array(
    	'type'         => 'integer',
    	'single'       => true,
    	'show_in_rest' => true,
    ) );

フィルター

[4.6.0]パラメータ$argsにデフォルト値を適用する前に'register_meta_args'フィルターを呼び出す。パラメータ$argsにはメタ情報の諸設定を格納した連想配列が、$defaultsには諸設定のデフォルト値を格納した連想配列が、$object_type$meta_keyには本関数が受け取った内容が格納されている。
$args = apply_filters( 'register_meta_args', $args, $defaults, $object_type, $meta_key );

アクション

直接実行するアクションはありません。

ソースファイル

/wp-includes/meta.php

最終更新 : 2024年05月25日 15:37



お勧め

JavaScriptテンプレートを使ってみた(2018年8月21日 更新)

前回の記事」で取り上げた「WordPress Events and News」ウィジェットでは入力された地名のAJAX処理してその地名近隣のイベント情報を表示している。特に表示部分では「JavaScriptテンプレート」が採用されており、今更ながら調べてみた。

投稿ページでユニークなテンプレートを選択しよう(2018年5月27日 更新)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

任意の名前でエラーログファイルを指定する(2019年2月15日 更新)

来週にはWordPress 5.1がリリース。RC1のソースコードを見ていると、 wp_debug_mode関数が変更されており、興味深かった。

投稿内容のid属性などを保存するための対策(2012年6月15日 更新)

WordPress 3.4にアップデートしたとある環境で投稿記事を保存すると、divタグなどのid属性がクリアされて保存するようになった(id属性が保存できなくなった)。ここでは、その対策方法の1つを紹介しておく。

query_posts(WP_Queryクラス)でカテゴリーを絞り込む(2011年9月14日 更新)

久しぶりに query_posts関数を見直してみると、見知らぬパラメータがいくつか追加されていた。気になったのでカテゴリー関係の指定を'tax_query'パラメータを交えて整理してみた。