概要
the_category
関数は、WordPress のテーマ開発において、投稿に関連するカテゴリーを表示するために使用されます。特に、以下のような機能を実装する際によく使われます:
- 投稿の詳細表示ページにカテゴリー名を表示する
- サムネイルリストの横にカテゴリーを追加する
- 検索結果一覧にカテゴリー情報を提供する
- カスタム投稿タイプのアーカイブページにカテゴリーを示す
- シングル投稿テンプレートでのメタ情報表示
- カテゴリー別のフィルタリング機能の実装
- ウィジェットエリアにカテゴリーリンクを表示する
- ショートコードで投稿のカテゴリー情報を表示する
構文
the_category( $separator, $parents, $post_id );
パラメータ
$separator
(オプション) – カテゴリー名を区切る文字列。デフォルトはカンマ。$parents
(オプション) – 親カテゴリーだけを表示するかどうかのフラグ。デフォルトは false。$post_id
(オプション) – 投稿の ID。デフォルトは現在の投稿。
戻り値
この関数は、HTMLタグでラップされたカテゴリー名を出力しますが、値を返すことはありません。
関連する関数
使用可能なバージョン
the_category
関数は、WordPress 2.0.0 以降で使用可能です。
コアファイルのパス
the_category
関数は、次のファイルに含まれています:
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 | 〇 |
サンプルコード
-
基本的なカテゴリー表示
<div class="post-categories"> <?php the_category(', '); ?> </div>
説明: 投稿のカテゴリーをカンマで区切って表示します。
-
カテゴリーのリンク付き表示
<div class="post-categories"> <?php the_category(' | '); ?> </div>
説明: カテゴリーを「|」で区切り、リンク付きで表示します。
-
親カテゴリーのみ表示
<div class="post-categories"> <?php the_category(', ', true); ?> </div>
説明: 親カテゴリーのみをカンマで区切って表示します。
-
特定投稿IDのカテゴリー表示
<div class="post-categories"> <?php the_category(', ', false, 42); ?> </div>
説明: 投稿ID 42 のカテゴリーをカンマで区切って表示します。
-
カテゴリーをラップしたHTML出力
<div class="post-categories"> <span class="category-label">Categories: </span> <?php the_category(', '); ?> </div>
説明: 「Categories:」というラベルの後にカテゴリー名を表示します。