get_registered_meta_keys

説明

array[] get_registered_meta_keys( string $object_type [ , string $object_subtype = '' ] )
メタフィールドのキー情報を取得する。

パラメータ

  • $object_type
    オブジェクトタイプ('post'、'comment'、'term'、'user'など)を指定。
  • $object_subtype
    [4.9.8]サブタイプを指定(省略時は'')。

返り値

パラメータ$object_typeおよび$object_subtypeにマッチするメタフィールドのキー情報(連想配列)を配列を返す。該当するメタフィールドがない場合は空の配列を返す。

注意

register_post_meta関数( register_meta関数)などによって登録されたメタフィールド情報を参照し、パラメータ$object_typeおよび$object_subtypeにマッチするものを返している。

[4.9.8]パラメータ$object_subtypeが追加された。

例えば、「投稿」のメタフィールドのキー情報は次のように取得する。

$keys = get_registered_meta_keys( 'post', 'post' );
var_dump( $keys );

$keysの内容は次に示すように、配列のキーにはメタフィールドのキー名が、値にはその属性情報が連想配列で格納されている。

array(1) {
  ["footnotes"]=>
  array(7) {
    ["type"]=>
    string(6) "string"
    ["description"]=>
    string(0) ""
    ["single"]=>
    bool(true)
    ["sanitize_callback"]=>
    NULL
    ["auth_callback"]=>
    string(13) "__return_true"
    ["show_in_rest"]=>
    bool(true)
    ["revisions_enabled"]=>
    bool(true)
  }
}

使用例

  • ユーザー情報のメタフィールドキー情報を取得する
    $keys = get_registered_meta_keys( 'user' );
  • カスタム投稿タイプのメタフィールドキー情報を取得する
    $keys = get_registered_meta_keys( 'post', $post_type );

フィルター

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

アクション

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

ソースファイル

/wp-includes/meta.php

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



お勧め

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。

ブロックエディターの文字サイズ設定を変えてみる(2019年12月12日 更新)

今回は「前回投稿した内容」の続きブロックエディターの文字サイズ設定を変えようと思う。参考にするテーマはもちろん「Twenty Twenty」である。

4.2で始まるiOSの絵文字ケア(2018年5月27日 更新)

WordPress 4.2のベータ1、ベータ2が立て続けにリリースされ、4.2の正式版リリースが近づいています。4.2のポイントの1つは絵文字のクロスブラウザ対応です。ここでの絵文字とは、UTF-8で4バイトのコードが割り当てられている(基本的にはiOSの)絵文字を指します。この絵文字を含んだ投稿が正しく保存できなかったり、iOS以外の環境で意図した通りに表示できないといった問題があり、4.2ではそのような問題を対処をコードが組み込まれています。

「不明な書式」って何ですか。(2024年11月13日 更新)

オートコンプリート機能を利用して四字熟語を挿入するプラグインを作った際、ツールバーに「不明な書式をクリア(Clear Unknown Formatting)」ボタンが表示されるようになった。この「書式」、何を指しているのかわからないんだが。

決まった値を返すだけの関数群(2018年5月27日 更新)

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。