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

お勧め

Posts filter multiselect：プラグイン作ってみました（2022年4月8日 更新）

先週の金曜日、知り合いの方から「投稿一覧ページで絞り込みを行う際、複数選択できないか」といった問い合わせがあり、その時には「標準では無理ですね」と返答しました。このこと自体は事実なのですが、要するに「複数選択可能なドロップダウンメニュー」が実現できれば対応するのはそれほど難しくないような気がしました。この週末、そんなノリでちょっとコーディングしてできたのがこのプラグインです。

全投稿を取得するのはnopaging=1でいい（2011年8月31日 更新）

query_posts関数（またはWP_Queryクラス）を使う場合、取得する件数の指定を省略すると管理者ページの「表示設定」－「1ページに表示する最大件数」の指定値分だけの投稿情報を取得する。それでは条件にマッチするすべての投稿情報を取得するには？

Contact Form 7に確認フェーズを（2012年12月16日 更新）

Contact Form 7はWordPressによるサイト製作でお世話になることが多いプラグインの1つ。ただ、クライアント様によっては、入力、確認、送信の3フェーズにしたいという要望があり、そんな時は別の方法を採用していたのですが、JavaScript（jQuery）を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。

古めのリビジョンを削除した時のメモ（2022年5月16日 更新）

大きく育ったデータベースを整理するため、古めのリビジョンとそれに紐づいたカスタムフィールドデータを削除。と思ったら「The total number of locks exceeds the lock table size」というエラーが発生して削除できなかった。

プラグインで注意が必要な関数（2013年11月27日 更新）

先日「Login rebuilder」という自作プラグインをアップデートした際、ユーザーさんからエラーになると連絡をいただいた。標準環境では問題なく、どうやら何らかのプラグインが影響しているらしい。