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



お勧め

HTML編集モードに定型文ボタンを追加する(2011年6月1日 更新)

投稿編集ページにはビジュアル編集モードとHTML編集モードがあり、それらを拡張するプラグインも多数存在している。そういったプラグインを利用するのもいいのだが、仕組みを理解するのも悪くないはず。というわけで、ここではHTML編集モードのボタンの仕組みと定型文を挿入するボタンを追加する方法を紹介する。

4.4では投稿ページも専用テンプレートが適用できる(2018年5月27日 更新)

従来、特定の固定ページには専用テンプレートを適用できるのですが、投稿ページに適用させるためにはアクションやフィルターを利用する必要がありました。4.4では特定の投稿ページに標準で専用テンプレートを適用できるようになりそうです。

3.2標準テーマ「Twenty Eleven」は投稿フォーマットに着目(2011年7月6日 更新)

新テーマ「Twenty Eleven」のトップページでは、投稿フォーマットに応じて表示を切り替える仕組みが提案されている。ここでは、その投稿フォームの活用方法を簡単に紹介する。

標準で使用できる数少ないショートコード[caption]とは(2018年5月27日 更新)

画像をアップロードして「投稿に追加」ボタンをクリックすると、投稿記事内にリンク付きのimgタグか、ショートコードのが挿入される。ここではそれらの書式を整理する。

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

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