説明
パラメータ
- $args検索条件を指定する文字列または連想配列。主なキーワードは次の通り。
キーワード 意味 show_option_all トップページURLのテキストを指定(省略時は'') show_option_none カテゴリーがない場合のテキストを指定(省略時は__('No categories')) show_last_update 最終更新日を出力する場合はtrue、出力しない場合はfalseを指定(省略時はfalse) style li要素で出力する場合は'list'を指定。それ以外はa要素の列挙となる(省略時は'list') show_count 投稿数を表示する場合はtrue、表示しない場合はfalseを指定(省略時はfalse) use_desc_for_title title属性にカテゴリーの説明を指定する場合は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) hierarchical true(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にはこの関数のパラメータの値が入る。アクション
実行するアクションはありません。ソースファイル
/wp-includes/category-template.php最終更新 : 2015年12月10日 17:23
関連
お勧め
Login rebuilder 2.3.0の新機能を紹介(2018年5月27日 更新)
プラグイン「Login rebuilder」はログイン時の履歴(ログ)や不正なログインページへのアクセス履歴を保存している。これらの履歴情報はダッシュボートで確認できるが、バージョン2.3.0においてそれぞれがダウンロードできるようになった。
古めのリビジョンを削除した時のメモ(2022年5月16日 更新)
大きく育ったデータベースを整理するため、古めのリビジョンとそれに紐づいたカスタムフィールドデータを削除。と思ったら「The total number of locks exceeds the lock table size」というエラーが発生して削除できなかった。
決まった値を返すだけの関数群(2018年5月27日 更新)
WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。
「Align widgets horizontally」プラグインのフィルター使用例(2024年5月15日 更新)
ダッシュボードのウィジェットを横並びに変える「Align widgets horizontally」プラグインには緒設定を変更できるフィルターが用意されている。ここではフィルターの使い方と設定できる項目について紹介する。
WP_Postオブジェクトで投稿情報を直感的に使う(2012年10月4日 更新)
WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。