説明
string wp_list_categories( [ mixed $args = '' ] )
カテゴリーリストを表示または取得する。
パラメータ
- $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にはこの関数のパラメータの値が入る。$output = apply_filters( 'wp_list_categories', $output, $args );
アクション
実行するアクションはありません。ソースファイル
/wp-includes/category-template.php最終更新 : 2015年12月10日 17:23
関連
お勧め
Emojin:プラグイン作ってみました(2015年3月21日 更新)
ちょっと前のTLでiOSの絵文字を含んだ投稿を保存すると、絵文字以降の文章がすべて消えた状態で保存されるといったツイートを見かけた。少し検索してみると、MySQLのデータベースの文字セットが「utf8」の場合、iOSの絵文字のような4バイトの文字を正常に保存できず、それ以降の文章も保存されないというものらしい。対処方法としてデータベースの文字セットを「utf8mb4」に変更するのが有効らしいのだが、他に回避策がないか考えてみた。Twenty Seventeenのフォントサイズを変更してみた(2021年12月15日 更新)
先日投稿した「続テーマを変更せずにWebフォントを使ってみた」では、テーマ「Twenty Seventeen」でもWebフォントを使えるようにした。その際、「Twenty Seventeen」のフォントサイズが少し小さく感じたので、今回はフォントサイズを調整してみた。
HTML entities button:プラグイン作ってみました(2021年4月28日 更新)
以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字(HTMLエンティティ)を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。5.7の機能拡張:エクスポートファイルに更新日時が追加ほか(2021年2月23日 更新)
WordPressはサイト移行を支援する機能として投稿情報のエクスポート機能を備えている。5.7ではこのエクスポート機能が改良され、更新日時情報が追加されるようだ。
query_posts(WP_Queryクラス)でカスタムフィールドを使う(2011年9月15日 更新)
先週3回にわたってtax_queryパラメータを使ったカテゴリーや投稿タグ、投稿フォーマットの絞り込みを整理したが、その途中で目に付いたのが'meta_query'パラメータ。この'meta_query'パラメータは、カスタムフィールドの絞り込み条件を指定するためのもので、3.2で登場した新しいパラメータのようだ。