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



お勧め

meta_compare_key使ってみた(2019年3月19日 更新)

ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名(メタキー)に含まれる文字列を指定する'meta_compare_key'キーだ。

WP_List_Tableクラスの「一括操作」フォームを使ってみた(2018年5月27日 更新)

今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」(Bulkアクション)フォーム対応に関するメモである。

テーマから投稿画像のサイズを指定する(2012年3月15日 更新)

投稿記事に挿入する画像サイズは、サムネイル(150×150)、中サイズ(300×300)、大サイズ(1024×1024)がデフォルトだが、テーマによっては別のサイズを指定したい場合はある。基本的には、「設定」-「メディア」の「メディア設定」ページで指定できるが、テーマ内のfunctions.phpで設定しておくとちょっと便利かもしれない。

ログインページを変える(2014年9月12日 更新)

WordPressの標準的な不正ログイン対策としては、ログインIDは'admin'を避けるパスワードはユニークで長くする、場合によってはアクセスできるIPアドレスを制限する、といった具合だろう。これらの他に何かできないものだろうかと、ちょっと考えてみた。

新規投稿時の本文プレースホルダーテキストを変える(2021年9月9日 更新)

ブロックエディターに影響を与えるフィルターは多数存在する。今回紹介するフィルターはその1つで、新規投稿時の本文ブロックのプレースホルダーテキストを変更するものだ。