register_term_meta()


WordPressのregister_term_meta()関数は、ターム（カテゴリーやタグなど）にカスタムメタデータを登録するために使用されます。これにより、タームに対して追加の情報を保存・管理することが可能になります。

構文

register_term_meta( string $taxonomy, string $meta_key, array $args = array() );

引数の説明:

  • $taxonomy (string) — メタデータを登録するタクソノミー（例: ‘category’, ‘post_tag’）。
  • $meta_key (string) — 登録するメタデータのキー。
  • $args (array) — メタデータの振る舞いを制御する追加の引数。

例1: カテゴリーにメタデータを登録

カテゴリーにシンプルなメタデータを登録する例です。

register_term_meta( 'category', 'custom_meta_key', array( 'type' => 'string', 'description' => 'カスタムメタデータの説明', 'single' => true ) );

例2: タグにデフォルト値を持つメタデータを登録

タグにデフォルト値を持つメタデータを登録する例です。

register_term_meta( 'post_tag', 'tag_meta', array( 'type' => 'string', 'default' => 'デフォルト値', 'single' => true ) );

例3: メタデータの検索を有効にする

メタデータの検索を有効にする例です。

register_term_meta( 'category', 'searchable_meta', array( 'type' => 'string', 'single' => true, 'show_in_rest' => true ) );

例4: メタデータの入力フィールドを追加

ターム編集画面にメタデータの入力フィールドを追加する例です。

register_term_meta( 'category', 'custom_field', array( 'type' => 'string', 'single' => true, 'show_in_rest' => true, 'sanitize_callback' => 'sanitize_text_field' ) );

例5: メタデータのバリデーションを設定

メタデータのバリデーションを設定する例です。

register_term_meta( 'category', 'validated_meta', array( 'type' => 'number', 'single' => true, 'sanitize_callback' => 'absint' ) );

例6: メタデータのREST APIでの表示を有効にする

メタデータをREST APIで表示する例です。

register_term_meta( 'category', 'rest_meta', array( 'type' => 'string', 'single' => true, 'show_in_rest' => true ) );

例7: 複数のメタデータを一度に登録

複数のメタデータを一度に登録する例です。

register_term_meta( 'category', 'meta_one', array( 'type' => 'string', 'single' => true ) ); register_term_meta( 'category', 'meta_two', array( 'type' => 'number', 'single' => true ) );

注意点

  • メタデータのキーは一意である必要があります。
  • メタデータの型を正しく設定しないと、データの保存や取得に問題が発生する可能性があります。
  • REST APIでメタデータを公開する場合は、セキュリティに注意してください。

関連機能：