• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

関数リファレンス/term description

提供: WordPress Codex 日本語版
移動先: 案内検索

WordPress バージョン 2.8 で登場したこのテンプレートタグは、指定されたタームの説明を返します。 ターム ID とタクソノミーをパラメータとして渡すことができますが、ターム ID を省いた場合は現在クエリされているターム(例えば投稿のカテゴリーやタグ)の説明を返します。

使い方

<?php echo term_description( $term_id, $taxonomy ) ?>

パラメータ

$term_id
整数) (オプション) 説明を返すタームの ID
初期値: 現在クエリされているタームの ID
$taxonomy
文字列) (オプション) タームが属するタクソノミーのスラッグ。
初期値: 'post_tag'
有効な値は:
  • 'category'
  • 'post_tag'
  • 'link_category'
  • カスタムタクソノミーのスラッグ

戻り値

(文字列) 
タームの説明。

用例

デフォルトの使い方では現在クエリされているタームの説明を返します。

<?php $description = term_description(); ?>

次の例は ID が 28 の投稿タグの説明を表示します。

<?php echo '投稿タグの説明:' . term_description( '28', 'post_tag' ); ?>

変更履歴

  • 2.8.0 から導入されました。

ソースファイル

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

category_description(), tag_description()

タームタグ: is_term(), term_exists(), get_objects_in_term(), get_term(), get_term_by(), get_term_children(), get_term_link(), get_terms(), get_the_terms(), get_the_term_list(), has_term(), sanitize_term(), the_terms(), get_object_taxonomies() is_object_in_taxonomy() the_taxonomies() wp_get_object_terms(), wp_set_object_terms(), wp_get_post_terms(), wp_set_post_terms(), wp_delete_object_term_relationships()



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


最新英語版: WordPress Codex » Function Reference/term_description最新版との差分