wp_list_categories()

wp_list_categories()関数は、カテゴリーのリストを表示するための非常に便利な関数です。この関数は、ブログのサイドバーやメニューなどにカテゴリーのリストを簡単に追加するために使用されます。以下に、wp_list_categories()関数の使用方法といくつかのパラメータについて説明します。

基本的な使用方法

<?php wp_list_categories(); ?>

これにより、デフォルト設定でカテゴリーのリストが表示されます。

パラメータ

wp_list_categories()関数は、さまざまなオプションを設定するための引数を受け取ります。以下に主なパラメータとその説明を示します。

  • show_option_all : 「すべてのカテゴリーを表示」というリンクを追加します。
  • orderby : カテゴリーの並べ替え基準（’name’, ‘count’, ‘slug’, ‘term_group’, ‘term_id’, ‘description’など）。
  • order : 並べ替えの順序（’ASC’または’DESC’）。
  • show_count : 各カテゴリーの投稿数を表示するかどうか（trueまたはfalse）。
  • hide_empty : 投稿がないカテゴリーを非表示にするかどうか（trueまたはfalse）。
  • exclude : 表示しないカテゴリーのID（カンマ区切りのリスト）。
  • include : 表示するカテゴリーのID（カンマ区切りのリスト）。
  • title_li : リストのタイトル。デフォルトは「Categories」。
  • depth : カテゴリーリストの深さ（整数値、0は無制限）。
  • echo : 結果を直接表示するか（true）変数に代入するか（false）。
  • taxonomy : 使用するタクソノミー（デフォルトは’category’）。
  • walker : カスタムウォーカーオブジェクトを指定する。

カスタム設定の例

以下は、いくつかのパラメータを使用してカテゴリーリストをカスタマイズする例です。

<?php
$args = array(
    'show_option_all'    => '',
    'orderby'            => 'name',
    'order'              => 'ASC',
    'show_count'         => true,
    'hide_empty'         => true,
    'exclude'            => '1,2,3',
    'include'            => '',
    'title_li'           => __( 'Categories' ),
    'depth'              => 2,
    'echo'               => true,
    'taxonomy'           => 'category',
    'walker'             => null
);
wp_list_categories( $args );
?>

パラメータの説明

  • show_option_all : 空文字列に設定しているので「すべてのカテゴリーを表示」のリンクは追加されません。
  • orderby : カテゴリー名で並べ替えます。
  • order : 昇順で並べ替えます。
  • show_count : 各カテゴリーの投稿数を表示します。
  • hide_empty : 投稿がないカテゴリーを非表示にします。
  • exclude : IDが1, 2, 3のカテゴリーをリストから除外します。
  • title_li : リストのタイトルを「Categories」に設定します。
  • depth : 階層を2レベルまで表示します。
  • echo : 結果を直接表示します。
  • taxonomy : ‘category’タクソノミーを使用します。
  • walker : デフォルトのウォーカーオブジェクトを使用します。

このように、wp_list_categories()関数は非常に柔軟で、さまざまなオプションを設定することでカテゴリーリストをカスタマイズすることができます。

カテゴリ関連の関数

  • wp_list_categories(): カテゴリーのリストを表示します。
  • get_categories(): カテゴリーのリストを取得します。
  • get_category(): 特定のカテゴリーを取得します。
  • get_category_link(): カテゴリーのリンクを取得します。
  • get_the_category(): 現在の投稿のカテゴリーを取得します。
  • single_cat_title(): カテゴリーページのタイトルを表示します。
  • category_description(): カテゴリーの説明を表示します。
  • wp_create_category(): 新しいカテゴリーを作成します。
  • wp_delete_category(): カテゴリーを削除します。
  • wp_insert_category(): カテゴリーを挿入または更新します。
  • get_cat_ID(): カテゴリー名からIDを取得します。
  • get_cat_name(): カテゴリーIDから名前を取得します。