概要
get_the_category_list関数は、投稿のカテゴリーをリンク形式でリスト化して表示するためのWordPress関数です。この関数は、主にカテゴリー別アーカイブのリンクリストを取得する際に使用されます。以下のようなシナリオでよく利用されます。
- 投稿詳細ページでのカテゴリー表示
- サイドバーにカテゴリーリストを表示
- カテゴリー別のフィルタリングオプションを提供
- カスタム投稿タイプでのカテゴリー表示
- テーマのカスタムウィジェットでカテゴリーリストを表示
- SEOの観点から、カテゴリーリンクを強調
- ショートコードを利用して任意のページにカテゴリーリストを埋め込む
- CRUD操作において、カテゴリー情報を管理するインターフェースの構築
構文
string get_the_category_list( string $separator = '', int $post_id = 0 )
パラメータ
- $separator: (string) 各カテゴリー間の区切り文字。デフォルトは空文字列。
- $post_id: (int) 対象となる投稿のID。省略された場合は現在の投稿が対象になります。
戻り値
- カテゴリーのリンクリストを含むHTML文字列。
関連する関数
get_the_category
get_category_link
the_category
has_category
使用可能なバージョン
この関数は、WordPress 2.3以降で使用可能です。
コアファイルのパス
wp-includes/category-template.php
この関数のアクションでの使用可能性
| アクション | 使用可能性 |
|---|---|
| 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: 投稿のカテゴリーリストを表示
$categories = get_the_category_list(', ');
echo '<div class="post-categories">' . $categories . '</div>';
このコードは、現在の投稿に関連するカテゴリーをカンマ区切りで表示します。
サンプルコード2: カテゴリーをハイパーリンクで表示
$categories = get_the_category_list(' | ');
echo '<p>Categories: ' . $categories . '</p>';
このコードは、カテゴリーをパイプ(|)で区切り、リンク形式で表示します。
サンプルコード3: 特定の投稿のカテゴリーリストを取得
$post_id = 42; // 任意の投稿ID
$categories = get_the_category_list(', ', $post_id);
echo '<div class="post-categories">' . $categories . '</div>';
このコードは、特定の投稿IDに基づいてカテゴリーリストを取得します。
サンプルコード4: カスタムスタイルを適用したカテゴリーリスト
$categories = get_the_category_list(', ', get_the_ID());
echo '<div class="custom-category-list">' . $categories . '</div>';
このコードでは、カスタムCSSスタイルを適用してカテゴリーリストを表示します。
サンプルコード5: 簡易な条件分岐でカテゴリー表示
if (get_the_category()) {
echo get_the_category_list(', ');
} else {
echo 'No categories assigned.';
}
このコードは、投稿にカテゴリーがない場合には「No categories assigned.」と表示します。