term_description()


WordPressのterm_description()関数は、指定されたターム(カテゴリーやタグなど)の説明を取得するために使用されます。

構文

term_description( int $term_id = null, string $taxonomy = '' );

引数の説明:

  • $term_id (int) — 説明を取得したいタームのID。デフォルトはnullで、現在のタームが使用されます。
  • $taxonomy (string) — タームが属するタクソノミー。デフォルトは空で、現在のタクソノミーが使用されます。

例1: 現在のタームの説明を表示

現在のタームの説明を表示する基本的な例です。

<?php echo term_description(); ?>

例2: 特定のタームIDの説明を表示

特定のタームIDを使用して説明を表示します。

<?php echo term_description( get_queried_object_id() ); ?>

例3: カテゴリーの説明を表示

特定のカテゴリーの説明を表示します。

<?php echo term_description( 5, 'category' ); ?>

例4: タグの説明を表示

特定のタグの説明を表示します。

<?php echo term_description( 10, 'post_tag' ); ?>

例5: カスタムタクソノミーの説明を表示

カスタムタクソノミーの説明を表示します。

<?php echo term_description( 15, 'custom_taxonomy' ); ?>

例6: 説明が存在する場合のみ表示

説明が存在する場合にのみ表示します。

<?php $description = term_description(); if ( ! empty( $description ) ) { echo $description; } ?>

例7: 説明をフィルタリングして表示

説明をフィルタリングして表示します。

<?php echo apply_filters( 'term_description', term_description() ); ?>

注意点

  • タームIDが正しく指定されていない場合、説明が取得できないことがあります。
  • タクソノミーが正しく指定されていない場合、説明が取得できないことがあります。
  • 説明が存在しない場合、空の文字列が返されます。

関連機能: