説明
パラメータ
- $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
関連
お勧め
ダッシュボードの「クイックドラフト」を「CodeMirror」に変更してみた(2019年11月5日 更新)
管理ページの「テーマエディター」では4.9以降「CodeMirror」が利用されている。今回はこの「CodeMirror」をプラグインで活用できないか調べた話である。
headタグのmeta(generator)タグを取り除く(2018年5月27日 更新)
標準的なWordPressのテーマで出力されるHTMLには、headタグ内に次のようなmetaタグが出力されている。<meta name="generator" content="WordPress 3.0.5" />
Blacklist keys manager:プラグイン作ってみました(2015年5月22日 更新)
少し前から明らかにスパムと思われるコメントが投稿され、そのモデレーションメールを受け取る回数が増えてきた。あまりにもあからさまなコメントばかりなので、何らかの対策ができないか考えてみました。
5.5の機能強化:テーマ変更時に要求バージョンを確認(2020年8月12日 更新)
WordPress 5.5 RC 2が公開され、来週には正式版がリリース。変更箇所が多い「WordPress 5.5 RC 2(以降RC 2)」のソースコードを眺めていると、テーマの切り替え前にWordPressとPHPのバージョンを確認するようになっていた。
投稿内容に応じてwpautopを制御する(2013年8月13日 更新)
投稿内容を表示する the_content関数では、 wpautop関数がフィルターの1つとして呼び出され、改行をbrタグに変換したり、pタグで調整したりする。この機能自体は便利なのだが、きちんとデザインされたHTMLソースを流し込んだ場合はこの機能は好ましくない。そんなわけで、記事内容に応じてwpautop関数を制御できないか考えてみた。