get_term_field()


WordPressのget_term_field()関数は、特定のタームのフィールド値を取得するために使用されます。この関数は、カスタムタクソノミーやカテゴリーのメタデータを取得する際に役立ちます。

構文

get_term_field( string $field, int|object $term, string $taxonomy = '', string $context = 'display' );

引数の説明:

  • $field (string) — 取得したいフィールドの名前。例: 'name', 'slug', 'description'。
  • $term (int|object) — タームのIDまたはタームオブジェクト。
  • $taxonomy (string) — タームが属するタクソノミー。例: 'category', 'post_tag'。
  • $context (string) — フィールドのコンテキスト。デフォルトは'display'。

例1: ターム名の取得

特定のカテゴリーの名前を取得する例です。

echo get_term_field( 'name', get_term_by( 'slug', 'news', 'category' ), 'category' );

例2: ターム説明の取得

特定のタグの説明を取得します。

echo get_term_field( 'description', get_term_by( 'slug', 'technology', 'post_tag' ), 'post_tag' );

例3: スラッグの取得

カテゴリーのスラッグを取得する例です。

echo get_term_field( 'slug', get_term_by( 'id', 123, 'category' ), 'category' );

例4: タクソノミーが指定された場合の利用

カスタムタクソノミーのターム名を取得します。

echo get_term_field( 'name', get_term_by( 'slug', 'custom-term', 'custom_taxonomy' ), 'custom_taxonomy' );

例5: コンテキストを指定して取得

編集用のコンテキストでターム説明を取得します。

echo get_term_field( 'description', get_term_by( 'id', 456, 'category' ), 'category', 'edit' );

注意点

  • get_term_field()は非推奨となる場合があるため、必要に応じてget_term_meta()を使用することを検討してください。
  • フィールドが存在しない場合、falseを返します。

関連機能：