概要
wp_list_categories 関数は、WordPressにおけるカテゴリーリストを表示または取得するための非常に便利な関数です。この関数は、サイドバーやメニューに関連するカテゴリーのリンクをリスト表示するためによく使用されます。主に以下のような機能や目的で利用されることが多いです。
- カテゴリーの一覧を表示する
- ナビゲーションバーの作成
- サイドバーウィジェットにカテゴリーリストを表示
- カテゴリーページへのリンクを提供
- トップページやアーカイブページでのカテゴリー情報の表示
- SEOを考慮したカテゴリーリンクの提供
- タグの表示と組み合わせて使用
- カスタム投稿タイプに関連するカテゴリーの表示
この関数は、WordPressのバージョン1.2以降で使用可能です。コアファイルのパスは wp-includes/category.php です。
構文
wp_list_categories( $args );
パラメータ
$args(配列): 表示するカテゴリーの設定を含む配列title_li(文字列): タイトルを特定の内容に設定（デフォルトは「Categories」）orderby(文字列): カテゴリーの並び順（例: ‘name’, ‘count’）order(文字列): 昇順または降順（’ASC’ or ‘DESC’）show_count(真偽値): 投稿数を表示するか否かhide_empty(真偽値): 空のカテゴリーを隠すか否か
戻り値
この関数は、HTML形式でカテゴリーリストの出力を行います。戻り値はありませんが、出力はビジュアルに表示されます。
関連する関数
この関数のアクションでの使用可能性
| アクション | 使用可能性 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | |
| init | |
| register_sidebar | |
| wp_loaded | |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | |
| template_redirect | |
| get_header | |
| wp_head |
サンプルコード
サンプルコード 1
<?php wp_list_categories(); ?>
このコードは、デフォルト設定で全てのカテゴリーをリスト表示します。
サンプルコード 2
<?php wp_list_categories(array('title_li' => '')); ?>
このコードは、カテゴリーリストのタイトルを非表示にします。
サンプルコード 3
<?php wp_list_categories(array('orderby' => 'name', 'order' => 'ASC', 'show_count' => true)); ?>
このコードは、カテゴリーを名前順に並べ、各カテゴリーの投稿数を表示します。
サンプルコード 4
<?php wp_list_categories(array('hide_empty' => true)); ?>
このコードは、空のカテゴリーを表示せずにリスト化します。
サンプルコード 5
<?php wp_list_categories(array('depth' => 1)); ?>
このコードは、カテゴリーの深さを1に制限し、サブカテゴリーを表示しません。