get_term_parents_list()


WordPressのget_term_parents_list()関数は、指定されたタームの親タームのリストを取得するために使用されます。この関数は、カテゴリーやタグなどのタクソノミーにおいて、階層構造を持つタームの親子関係を表示する際に役立ちます。

構文

get_term_parents_list( int $term_id, string $taxonomy, array $args = array() );

引数の説明:

  • $term_id(int) — 親タームを取得したいタームのID。
  • $taxonomy(string) — タームが属するタクソノミーの名前。
  • $args(array) — オプションの引数。以下のキーを持つ連想配列：
    • format(string) — リンクのフォーマット。デフォルトはlink。
    • separator(string) — リンク間の区切り文字。デフォルトは/。
    • link(bool) — リンクを表示するかどうか。デフォルトはtrue。
    • inclusive(bool) — 指定されたターム自体を含めるかどうか。デフォルトはtrue。

例1: 基本的な使用例

この例では、指定されたタームの親タームのリストを取得し、リンク付きで表示します。

<?php echo get_term_parents_list(get_queried_object_id(), 'category'); ?>

例2: 区切り文字の変更

この例では、親タームのリストを取得し、区切り文字を>に変更します。

<?php echo get_term_parents_list(get_queried_object_id(), 'category', array('separator' => '>')); ?>

例3: リンクなしで表示

この例では、親タームのリストをリンクなしで表示します。

<?php echo get_term_parents_list(get_queried_object_id(), 'category', array('link' => false)); ?>

例4: 指定されたタームを含めない

この例では、指定されたターム自体を含めずに親タームのリストを表示します。

<?php echo get_term_parents_list(get_queried_object_id(), 'category', array('inclusive' => false)); ?>

例5: カスタムフォーマット

この例では、親タームのリストをカスタムフォーマットで表示します。

<?php echo get_term_parents_list(get_queried_object_id(), 'category', array('format' => 'name')); ?>

例6: 複数の引数を組み合わせる

この例では、複数の引数を組み合わせて親タームのリストを表示します。

<?php echo get_term_parents_list(get_queried_object_id(), 'category', array('separator' => ' > ', 'link' => false, 'inclusive' => false)); ?>

例7: タームIDを直接指定

この例では、タームIDを直接指定して親タームのリストを取得します。

<?php echo get_term_parents_list(5, 'category'); ?>

例8: タクソノミーを変更

この例では、タクソノミーをpost_tagに変更して親タームのリストを表示します。

<?php echo get_term_parents_list(get_queried_object_id(), 'post_tag'); ?>

注意点

  • タームが階層構造を持たない場合、この関数は空の文字列を返します。
  • 指定されたタームが存在しない場合、関数はfalseを返します。
  • 引数$argsのformatにnameを指定すると、リンクなしでターム名のみが表示されます。

関連機能：