category_description()


WordPressのcategory_description()関数は、指定されたカテゴリーの説明を取得するために使用されます。この関数は、カテゴリーIDを引数として受け取り、そのカテゴリーの説明文を返します。

構文

category_description( int $category_id = 0 );
  • $category_id (int) — 説明を取得したいカテゴリーのID。デフォルトは0で、現在のカテゴリーを指します。

例1: 現在のカテゴリーの説明を表示

現在のカテゴリーの説明を表示する基本的な例です。

<?php echo category_description(); ?>

例2: 特定のカテゴリーの説明を表示

カテゴリーIDを指定して、そのカテゴリーの説明を表示します。

<?php echo category_description( get_cat_ID( 'サンプルカテゴリー' ) ); ?>

例3: カテゴリー説明を条件付きで表示

カテゴリーに説明が設定されている場合のみ、その説明を表示します。

<?php $cat_desc = category_description(); if ( ! empty( $cat_desc ) ) { echo $cat_desc; } ?>

例4: カテゴリー説明をHTMLタグ付きで表示

カテゴリー説明を<div>タグで囲んで表示します。

<?php echo '<div>' . category_description() . '</div>'; ?>

例5: カテゴリー説明をショートコード内で使用

ショートコード内でカテゴリー説明を取得し、表示する例です。

<?php function display_category_desc() { return category_description(); } add_shortcode( 'cat_desc', 'display_category_desc' ); ?>

例6: カテゴリー説明をカスタムクエリで使用

カスタムクエリを使用して、特定のカテゴリーの説明を表示します。

<?php $category = get_term_by( 'slug', 'custom-category', 'category' ); echo category_description( $category->term_id ); ?>

注意点

  • カテゴリー説明が設定されていない場合、この関数は空の文字列を返します。
  • カテゴリーIDが無効な場合も、空の文字列が返されます。

関連機能: