get_the_category_list

説明

string get_the_category_list( [ string $separator = '' [ , string $parents = '' [ , mixed $post_id = false ] ] ] )
投稿記事のカテゴリー別アーカイブのリンクリストを取得する。

パラメータ

  • $separator
    区切り文字。''の場合は、ulおよびliタグが適用される。
  • $parents
    親カテゴリー対応を指定('multiple'、'single'、''の何れか)。'multiple'の場合は親カテゴリーもリンク付きになる。
  • $post_id
    投稿情報ID。falseの場合は現在の投稿情報が適用される。

返り値

カテゴリー別アーカイブのリンクリストを返す。

注意

4.4で'the_category_list'フィルターが追加され、対象となるカテゴリー情報を調整できるようになった。


使用例

  • カテゴリー別アーカイブのリンクリストを取得する。
    <?php $cat_link = get_the_category_list( ); ?>

フィルター

[4.4.0] get_the_category関数で取得したカテゴリー情報は'the_category_list'フィルターを経由する。パラメータ$categoriesにはカテゴリー情報が、$post_idは本関数が受け取った値が格納される。
$categories = apply_filters( 'the_category_list', $categories, $post_id );
[1.2.0]値を返す直前に'the_category'フィルターを呼び出す。$thelistには返す直前の値が、$separator$parentsには本関数が受け取った値がそれぞれ格納される。
return apply_filters( 'the_category', $thelist, $separator, $parents );

アクション

直接実行するアクションはありません。

ソースファイル

/wp-includes/category-template.php

最終更新 : 2018年05月27日 10:48



お勧め

query_posts(WP_Queryクラス)で投稿タグを絞り込む(2011年9月14日 更新)

投稿タグの絞り込みは、カテゴリーに似ているけど微妙に違っている。今日は、昨日投稿した「query_posts(WP_Queryクラス)でカテゴリーを絞り込む」の続きとして、投稿タグの絞り込みついてまとめてみる。

管理者ページに文言を表示する(2012年4月19日 更新)

お客様向けに管理者ページをカスタマイズする機会が増えてきている。カスタマイズするページや表示場所、表示内容によっていくつかの手段があるが、今回はページの冒頭部分に任意の文言を表示する方法を紹介する。

oEmbedについて考えてみた(2018年5月27日 更新)

本サイト向けにテーマをリニューアルしようと思い一から作っている最中、ふと生成されているHTMLの中にあるoEmbedの記述が目についた。「この記述いつからだっけ」くらいに思いながらリンク先を開き、ちょっとモヤモヤしてしまった。

ショートコードを含んだページを表示する前に何か処理する(2014年5月28日 更新)

固定ページまたは投稿ページに独自のフォームを埋め込む。入力→登録の2段階のフォームなら著名なプラグイン「Contact Form 7」を利用すればいいのだが、クライアントの依頼は入力→確認→登録の3段階で組み込む要素が特化していたので、独自の実装方法を考えることになった。

WP_Postオブジェクトで投稿情報を直感的に使う(2012年10月4日 更新)

WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。