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



お勧め

決まった値を返すだけの関数群(2018年5月27日 更新)

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

the_date関数で投稿日を確実に表示する(2011年12月20日 更新)

投稿記事の投稿日時を表示する際、 the_date関数を使用することが多いだろう。このthe_date関数はphpのdate関数と同じパラメータを指定することで、好みの日時フォーマットで投稿日時を表示できるのだが、ある条件の場合に投稿日時を表示しない。最初にこの現象に遭遇したときは、ちょっと悩まされた。

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

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

さくらのVPSでKUSANAGI(2018年5月27日 更新)

請け負っていた業務が一段落したので、「さくらのVPS」で「KUSANAGI」を試してみました。推奨環境はメモリ4GBとなっているが、今回は実験的な利用なので、SSD 2GBプランでトライしました。

絵文字画像がPNGからSVGへ(2018年5月27日 更新)

WordPressでは絵文字に対応していないブラウザ環境で絵文字を表示する仕組みをバージョン4.2から提供。絵文字に対応しているブラウザとそん色がない表示を実現する。