register_meta

パラメータ

• $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']に適用される。

返り値

注意

本関数は投稿メタ（カスタムフィールド）やコメントメタなどのメタ情報を登録する場合に使用する。投稿メタの登録は、 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,
  ) );

フィルター

$args = apply_filters( 'register_meta_args', $args, $defaults, $object_type, $meta_key );

アクション

ソースファイル