wp_list_categories

説明

string wp_list_categories( [ mixed $args = '' ] )
カテゴリーリストを表示または取得する。

パラメータ

  • $args
    検索条件を指定する文字列または連想配列。主なキーワードは次の通り。
    キーワード意味
    show_option_allトップページURLのテキストを指定(省略時は'')
    show_option_noneカテゴリーがない場合のテキストを指定(省略時は__('No categories'))
    show_last_update最終更新日を出力する場合はtrue、出力しない場合はfalseを指定(省略時はfalse)
    styleli要素で出力する場合は'list'を指定。それ以外はa要素の列挙となる(省略時は'list')
    show_count投稿数を表示する場合はtrue、表示しない場合はfalseを指定(省略時はfalse)
    use_desc_for_titletitle属性にカテゴリーの説明を指定する場合はtrue、カテゴリー名の場合はfalseを指定(省略時はtrue)
    feedフィードリンクを付ける場合はそのテキストを指定(省略時は'')
    feed_typeフィードタイプを指定(省略時は'')
    feed_imageフィードリンクで使用する画像URLを指定(省略時は'')
    current_category現在の(投稿の)カテゴリーIDを指定(省略時は0)。
    title_li見出しを指定(省略時は__( 'Categories' ))
    echo表示する場合はtrue、取得する場合はfalseを指定(省略時はtrue)
    depth階層付きの場合はtrue、階層なし(フラット)の場合はfalseを指定(省略時はfalse)
    taxonomyタクソノミーのスラッグを指定(省略時は'category')
    hide_title_if_empty[4.4.0]空の見出しを隠す(非表示にする)場合はtrueを指定(省略時はfalse)
    separator[4.4.0]区切り文字を指定(省略時は'<br />')

    内部で呼び出される get_categoriesと共通するパラメータは次の通り。
    キーワード意味
    orderbyソート対象を示すcount、name、slug、term_group、none、idなど(省略時は'name')
    orderソート順を示すASCかDESC(省略時はASC)
    hide_empty投稿記事がないカテゴリーを取得しない場合はtrue(1)、投稿記事がないカテゴリーも取得する場合はfalse(0)を指定(省略時はtrue)
    exclude取得したくないカテゴリーのID(複数指定する場合は,で区切る。省略時は'')
    exclude_tree取得したくないカテゴリーのID(複数指定する場合は,で区切る。省略時は'')。指定されたIDのカテゴリーが子カテゴリーを持っている場合、それらの子カテゴリーも除外される。
    child_ofカテゴリーのIDを指定(そのIDのカテゴリーの子孫がすべて対象となる。省略時はfalse)
    hierarchicaltrue(1)またはfalse(0)を指定(省略時はtrue)

返り値

パラメータ$argsで'echo=0'を指定した場合はカテゴリーリストのHTMLテキストを返す。'echo=1'の場合は何も返さない。

注意

デフォルトでは'hide_empty'が1(true)のため、投稿のないカテゴリーは含まれない。投稿数に関係なくすべてのカテゴリーを表示(取得)する場合は、'hide_empty=0'を指定する。
なお、'taxonomy'で'category'以外を指定すると、投稿タグやその他のタクソノミーのリストを表示(取得)できる。

[4.4.0]'current_category'にはカテゴリーIDを指定できるが、4.4以降は配列で複数のカテゴリーIDを指定できる。


使用例

  • 投稿記事があるカテゴリーリストを表示する。
    <?php wp_list_categories(); ?>
  • 全てのカテゴリーリストを取得する。
    <?php $list = wp_list_categories( 'echo=0&hide_empty=0&hierarchical=1' ); ?>

フィルター

HTMLテキストを表示または返す直前にwp_list_categoriesフィルターを実行する。$outputにはHTMLテキストを、$argsにはこの関数のパラメータの値が入る。
$output = apply_filters( 'wp_list_categories', $output, $args );

アクション

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

ソースファイル

/wp-includes/category-template.php

最終更新 : 2015年12月10日 17:23



お勧め

管理画面でツールバー(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アクションがあったので、紹介しておく。