
目次
category_description()の用途
category_description()
は、WordPressでカテゴリーの説明文(description)を取得・表示するためのテンプレートタグです。主にカテゴリーアーカイブページで使用されます。
category_description()の基本構文
category_description( int $category );
category_description()のパラメータ
引数 | 型 | 説明 |
---|---|---|
$category | int | カテゴリーID。省略すると現在のカテゴリーが対象になります。 |
category_description()の使用例
1. 現在のカテゴリーの説明を表示する
echo category_description();
現在のクエリに対応するカテゴリーの説明が表示されます(主にアーカイブページなど)。
2. 特定のカテゴリーIDの説明を表示する
echo category_description(5);
IDが「5」のカテゴリーの説明を表示します。
category_description()の注意点
category_description()
はHTMLを含む文字列を返すため、echo
を使って出力する必要があります。- カスタムタクソノミー(例: タグや独自タクソノミー)の説明を取得したい場合は
term_description()
を使ってください。
補足:説明文の登録方法
管理画面から以下の手順で登録できます:
- WordPress管理画面 > 投稿 > カテゴリー
- 任意のカテゴリーを編集
- 「説明」欄にテキストを入力
ヒント:条件付きで表示
カテゴリー説明がある場合だけ表示する処理例:
$desc = category_description();
if ( ! empty( $desc ) ) {
echo '<div class="cat-description">' . $desc . '</div>';
}
関連関数との違い
関数名 | 用途 |
---|---|
category_description() | カテゴリーの説明を取得 |
term_description() | 任意のタクソノミー(カテゴリ、タグなど)の説明を取得 |
get_the_category() | 投稿が属するカテゴリーの情報を取得(配列) |