説明
パラメータ
- $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)
返り値
カスタムフィールドを登録できた場合は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
お勧め
ブロックエディターの色設定を変えてみる(2019年12月11日 更新)
バージョン5.3で機能強化されたブロックエディター。対応を考えて新テーマ「Twenty Twenty」のソースコードを眺めていく。
「姓」の後に「名」を(2013年11月6日 更新)
WordPressのユーザー情報設定ページでは、「名(First name)」の後に「姓(Last name)」を入力するようになっている。日本向けのユーザー登録できるサイトの場合、この並び順はちょっと違和感があるので、「姓」「名」の順に入力できるようにした。
ホームディレクトリから過去のファイルを削除する(2013年1月27日 更新)
WordPressで構築したサイトのホームディレクトリには、現在使われていないファイルが残っている時がある。3.5.1もリリースされたことだし、これを機にホームディレクトリを整理整頓した。Login rebuilder 2.6.5の新機能紹介(2021年3月8日 更新)
今回追加したものは、管理者のダッシュボードに表示されるログウィジェットの日時について任意の書式を設定する機能である。これまで日時の書式はサイト設定を利用していたが、ログの日時については揃えた方が見やすいと思ったので、今回の機能で対応することにしました。
投稿情報を連想配列で参照する(2018年5月27日 更新)
投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。