wp_list_categories() の使い方|説明・引数・注意点

説明

wp_list_categories() は、カテゴリーの一覧を、HTMLのリストとして出力する関数です。

基本構文

wp_list_categories( array|string $args = '' ): void|string|false

引数

  • $args:title_li、show_count、orderby、hierarchical、taxonomy、echo など

戻り値

echo が true なら出力、false なら文字列。

使い方(サンプル)

wp_list_categories( array(
	'title_li'   => '',
	'show_count' => true,
) );

注意点

  • 既定では li 要素を出力するため、外側に ul 要素が必要です。
  • title_li を空にすると見出しが出力されません。

実務での使いどころ

  • カテゴリーの一覧を、リスト(<li>)として、そのまま出力するとき。
  • カスタムタクソノミーの、ターム一覧を、リストで出力するとき(taxonomy を指定)。

よくあるミスと対処

  • <ul> で囲んでいない。この関数は、<li> だけを出力する。
  • 見出し(title_li)が、既定で出力される。見出しが不要なら、'title_li' => '' を指定する。
  • hide_empty の既定は true。投稿のないカテゴリーは、表示されない。

NG例

wp_list_categories(); // ul がなく、見出しも出る

OK例

echo '<ul>';
wp_list_categories( array(
	'title_li'   => '',
	'hide_empty' => false,
) );
echo '</ul>';

使い分け早見表

やりたいこと 使うもの
リストのHTMLを出力 wp_list_categories()
プルダウンのHTMLを出力 wp_dropdown_categories()
配列で取得して、自分でHTMLを作る get_categories()

関連項目

get_categories()、wp_dropdown_categories()

公式リファレンス:wp_list_categories() | Function | WordPress Developer Resources

コメント

タイトルとURLをコピーしました