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



お勧め

Somewhere search box:プラグイン作ってみました(2018年5月8日 更新)

投稿済みの記事を修正する際、毎回「投稿一覧」に戻るのは面倒だ、そんなことを感じて作ったのがこのプラグインです。また1.2.0では投稿内容(本文、カテゴリーや投稿タグ、カスタムフィールド)を複製するリンクを投稿一覧ページと投稿編集ページに追加、1.3.0では投稿タイトルのみの検索をサポートしました。

HTML entities button:プラグイン作ってみました(2017年12月17日 更新)

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字(HTMLエンティティ)を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。

get_postsとquery_postsを使い分け(2018年5月27日 更新)

get_posts query_postsは、どちらも複数の投稿情報を取得することができる便利な関数である。パラメータとして指定できる内容も共通しているものが多く、query_postsがより詳細なパラメータを指定でき、高機能になっている。

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

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

使っていないか確認しないとね!(2017年11月18日 更新)

2003年に誕生したWordPress。その歴史の中には、廃止予定(deprecated)となっている関数がいくつも存在する。それらの関数をテーマやプラグインで使用するべきではないし、使用しているなら代替の関数に書き換えるべきである。ここでは3.24.9.0現在、廃止予定となっている関数をまとめて紹介する。