register_post_meta

（4.9.8以降）
register_post_meta - 投稿向けのカスタムフィールドを登録する

説明

bool register_post_meta( string $post_type, string $meta_key, array $args )
投稿向けのカスタムフィールドを登録する。

パラメータ

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

返り値

カスタムフィールドを登録できた場合はtrueを、登録できなかった場合は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 ) );

フィルター

直接実行するフィルターはありません。

アクション

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

ソースファイル

/wp-includes/post.php

最終更新 : 2023年12月28日 11:51

関連

参考

Code Reference: register_post_meta

お勧め

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

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

Gutenbergでカスタムフィールドを使う（2018年8月10日 更新）

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

Slightly troublesome permalink：プラグイン作ってみました（2021年4月20日 更新）

カテゴリーを含んだパーマリンクを設定している場合、複数のカテゴリーを指定した投稿記事のパーマリンクのURLに目的のカテゴリーとは異なるカテゴリーが適用された経験はないだろうか。このプラグインは、パーマリンクに適用されるカテゴリーをコントロールし、希望通りのパーマリンクを設定します。

WP_Postオブジェクトで投稿情報を直感的に使う（2012年10月4日 更新）

WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。

テキストエディタの文字を変更する（2018年5月27日 更新）

テキストエディタ（投稿ページの「テキスト」タブのエディタ）に標準では備わっていない機能を追加する自作プラグイン「html entities button」がほぼ1年ぶりにアップデート。ここではバージョン2.0.0で追加したテキストエディタのフォント切り替え機能について紹介する。