テンプレートタグ/category description

説明

現在のカテゴリーについて、カテゴリー管理画面（投稿 > カテゴリー）で設定した「カテゴリーの説明」を返します。 archive.php テンプレートで使う場合、条件分岐タグ is_category() の内側で使ってください。 そうしないと、月別アーカイブや他のアーカイブページの処理がこの関数のところで停止してしまいます。

使い方

<?php echo category_description( $category_id ); ?>

パラメータ

$category_id

（整数） （オプション） 説明を取得するカテゴリーの ID

初期値： 現在のページのカテゴリー ID

用例

デフォルトの使い方

ID を指定してテンプレートタグの戻り値を echo することで、カテゴリーの説明を表示します。 カテゴリーを指定せずにカテゴリーアーカイブのページで使用すると、現在のカテゴリーの説明を返します。

<div><?php echo category_description(3); ?></div>

出力例：

WordPress is a favorite blogging tool of mine and I share tips and tricks for using WordPress here.

参考：カテゴリーの説明がない場合、このテンプレートタグは HTML の br タグを返します。

カテゴリーのスラッグから取得

カテゴリーのスラッグを指定してカテゴリーの説明を表示します。

<?php echo category_description( get_category_by_slug('category-slug')->term_id ); ?>

カテゴリーのタイトルと一緒に表示

<div><strong><?php single_cat_title('Currently browsing'); ?>
</strong>: <?php echo category_description(); ?></div>

出力例：

Currently browsing WordPress: WordPress is a favorite blogging tool of mine and I share tips and tricks for using WordPress here.

変更履歴

• バージョン 1.0.0 にて導入されました。

参考

• 内部で term_description() を使用します。

ソースファイル

category_description() は wp-includes/category-template.php にあります。

関連項目

カテゴリータグ： the_category(), the_category_rss(), single_cat_title(), category_description(), wp_dropdown_categories(), wp_list_categories(), get_the_category(), get_the_category_by_ID(), get_category_by_slug(), get_the_category_list(), get_category_parents(), get_category_link(), is_category(), in_category()

関数リファレンス、テンプレートタグ目次もご覧ください。

最新英語版： WordPress Codex » Template Tags/category_description （最新版との差分）