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

最終更新 : 2021年12月15日 15:16

参考

Code Reference: register_post_meta

お勧め

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

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

子カテゴリのアーカイブページを親カテゴリ用のテンプレートファイルで表示しよう（2011年12月8日 更新）

少し前に投稿した「適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす」で説明した通り、特定のカテゴリ専用のテンプレートとしてcategory-○○.phpを用意することで、category.phpやarchive.php内で振り分けを行う必要がなくなる。ただ、すべてのカテゴリ分を用意するのは効率的ではないし、特に子カテゴリについては親カテゴリと共通内容になるケースが多いのではないだろうか。ここでは、子カテゴリの個別テンプレートファイルを作らず、親カテゴリのテンプレートを利用する方法を紹介する。

5.3の新機能：日付とタイムゾーン（2019年10月2日 更新）

「WordPress 5.3 Beta 1」に記載されていた「Time/Date component fixes」という見出し。開発者向として新しい関数の追加や多くのバグが修正されたとなっており、チェックせざるを得ない。

Login rebuilderのログ表示機能を紹介（2018年5月27日 更新）

プラグイン「Login rebuilder」には、バージョン1.2.0からログ情報を保存・確認する機能が備わっています。このログ情報では直近のログインページへの不正アクセスやログイン試行を確認できます。ここでは保存しているログ情報の見方について簡単に説明します。

さくらのVPSでKUSANAGI#3（2018年5月27日 更新）

今回は「前回」の続き。http（80番）をクローズ、そのほかに行った調整作業について整理する。