当サイト、Codex 日本語版は今後積極的な更新は行わない予定です。後継となる新ユーザーマニュアルは、https://ja.wordpress.org/support/ にあります。
万が一、当サイトで重大な問題を発見した際などは、フォーラムWordSlack #docs チャンネルでお知らせください。</p>

テンプレートタグ/tag description

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

WordPress バージョン 2.8 で登場したこのテンプレートタグは、タグの説明を返します。 タグ ID をパラメータとして渡すことができますが、何も渡されなかった場合は現在クエリされているタグの説明を返します。

使い方

<?php tag_description( $tag_id ); ?>

デフォルトの使い方

デフォルトのまま使うと、現在クエリされているタグの説明を返します。

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

パラメータ

$tag_id
整数) (オプション) 説明を取得するタグの ID
初期値: 現在クエリされているタグ。

戻り値

(文字列) 
タグの説明(あれば)。

用例

ID が 28 のタグの説明を返します。

<?php echo 'Tag Description: ' . tag_description( '28' ); ?>

変更履歴

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

参考

  • 内部で term_description() を使用します。
  • 出力は <p> タグで囲まれます。

ソースファイル

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


タグ: get_tag(), get_tag_link(), get_tags(), get_the_tag_list(), get_the_tags(), is_tag(), the_tags(), single_tag_title(), tag_description(), wp_generate_tag_cloud(), wp_tag_cloud()


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


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