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



お勧め

管理画面でツールバー(Admin bar)を非表示にする(2013年3月5日 更新)

WordPress使ってちょっと変わったサイトを構築する際、管理画面のツールバーを表示させたくないケースがある。一般に公開するサイト側であれば、 show_admin_bar関数で非表示にできるのだが、管理画面ではこれを使ってもツールバーは消えてくれない。

サイドバーの初期化はwidgets_initアクションで(2011年7月14日 更新)

ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。

タイトルが一致する投稿を検索する(2014年2月20日 更新)

WordPressが提供する投稿ページの文字列検索機能の実現には、 query_posts関数(WP_Queryクラス)が大きな役割を担っている。ここで紹介するのは、高機能ゆえに使いこなすのが難しいquery_posts関数(WP_Queryクラス)の使用法の一例である。

投稿ページでユニークなテンプレートを選択しよう(2018年5月27日 更新)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

WordPressの鼓動(2013年10月1日 更新)

WordPressでは、Ajaxを利用する方法の1つとして add_action関数を利用することができる。この方法を調べている過程で、'heartbeat'というおもしろそうなAjaxアクションがあったので、紹介しておく。