テンプレートタグ/get category parents

説明

指定されたカテゴリーの親カテゴリーのリストを取得します。 指定されたカテゴリーも含めて、階層の順序で出力します。

使い方

<?php get_category_parents( $id, $link, $separator, $nicename, $visited ); ?>

パラメータ

$id

（整数） （必須） カテゴリー ID

初期値： なし

$link

（真偽値） （オプション） 各カテゴリーへのリンクを出力するか否か。

初期値： false - 出力しない

$separator

（文字列） （オプション） 各カテゴリーを区切る文字列。

初期値： '/'

$nicename

（真偽値） （オプション） カテゴリー名の代わりにスラッグを出力するか否か。

初期値： false - カテゴリー名を出力

$visited

（配列） （オプション） リンク済みカテゴリーの配列。このパラメータは、この関数が自分を再帰的に呼び出すとき、結果のリストにカテゴリーの重複を避けるために使用されます。

初期値： array() - 空の配列

戻り値

(文字列|WP_Error) 

$separator で区切られたカテゴリー。失敗した場合は WP_Error を返す。

用例

現在のカテゴリーの親カテゴリーを、リンク付きで '»' で区切って返します。

<?php echo get_category_parents( $cat, true, ' &raquo; ' ); ?>

出力例 1 - リンク無し：
Internet » Blogging » WordPress »

出力例 2 - リンク付き：
<a href="http://example.com/?cat=2" title="Wordpress の投稿をすべて表示">Wordpress</a> » <a href="http://example.com/?cat=4" title="Wordpressテーマ の投稿をすべて表示">Wordpressテーマ</a> »

変更履歴

• バージョン 1.2.0 にて導入されました。

ソースファイル

get_category_parents() は wp-includes/category-template.php にあります。

関連項目

カテゴリータグ： the_category(), the_category_rss(), single_cat_title(), category_description(), wp_dropdown_categories(), wp_list_categories(), get_the_category(), get_the_category_by_ID(), get_category_by_slug(), get_the_category_list(), get_category_parents(), get_category_link(), is_category(), in_category()

関数リファレンス、テンプレートタグ目次もご覧ください。

最新英語版： WordPress Codex » Function Reference/get_category_parents （最新版との差分）