register_post_meta

パラメータ

• $post_type
  投稿タイプを指定。
• $meta_key
  カスタムフィールド名を指定。
• $args
  カスタムフィールドの属性情報を連想配列で指定。

  キー	型	内容
  'type'	string	データタイプとして'string'、'boolean'、'integer'、'number'、'array'および'object'のいずれか（省略時は'string'）
  'description'	string	カスタムフィールドの説明（省略時は''）
  'default'	mixed	[5.5.0]カスタムフィールドの初期値（省略時は''）
  'single'	bool	1つカスタムフィールド名で複数の値を保持しない場合はtrueを指定（省略時はfalse）
  'sanitize_callback'	callable	サニタイズ用のコールバック関数（省略時はnull）
  'auth_callback'	callable	ケイパビリティ（権限）確認用のコールバック関数（省略時はnull）
  'show_in_rest'	bool|array	REST API向けの設定（省略時はfalse）

返り値

注意

本関数はすぐに register_meta関数を呼び出す。その際、本関数のパラメータ$post_typeはパラメータ$argsのキー'object_subtype'の値となる。

ブロックエディターでカスタムフィールドを使用する場合、本関数を使って登録する必要がある（バージョン5.8.2現在）。

'sanitize_callback'と'auth_callback'に指定するコールバック関数のパラメータは次の通り。

function sanitize_func( mixed $meta_value, string $meta_key, string $object_type, string $object_subtype )

function auth_func( bool $allowed, string $meta_key, int $object_id, int $user_id, string $cap, array $caps )

使用例

• 投稿向けのカスタムフィールド'extra_text'を登録する

  register_post_meta( 'post', 'extra_text', array( 'single' => true ) );

フィルター

アクション

ソースファイル