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

「テンプレートタグ/tag description」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(ページ翻訳)
(en:Template Tags/tag_description 17:31, 5 March 2013 Adam.samec 版を反映して少し改訳。)
 
1行目: 1行目:
{{CheckTrans}}
+
<div id="Description">
 
== 説明 ==
 
== 説明 ==
WordPress [[Version 2.8|バージョン 2.8]] で登場したこのテンプレートタグは、タグの説明を返します。タグ ID をパラメータとして渡す事ができますが、何も渡されなかった場合は現在クエリされているタグの説明を返します。
+
</div>
 +
 
 +
WordPress [[Version 2.8|バージョン 2.8]] で登場したこのテンプレートタグは、タグの説明を返します。
 +
タグ ID をパラメータとして渡すことができますが、何も渡されなかった場合は現在クエリされているタグの説明を返します。
  
 
<div id="Usage">
 
<div id="Usage">
 
== 使い方 ==
 
== 使い方 ==
 
</div>
 
</div>
<?php tag_description('tagID'); ?>
 
  
<div id="Default_Usage">
+
<?php tag_description( $tag_id ); ?>
===デフォルトの使い方===
+
 
 +
<div id="Default Usage">
 +
=== デフォルトの使い方 ===
 
</div>
 
</div>
デフォルトで使うと、現在クエリされているタグの説明を返します。
 
  
<pre><?php $tag_descr = tag_description(); ?></pre>
+
デフォルトのまま使うと、現在クエリされているタグの説明を返します。
 +
 
 +
<pre><?php $description = tag_description(); ?></pre>
 +
 
 +
<div id="Parameters">
 +
== パラメータ ==
 +
</div>
 +
 
 +
{{Parameter|$tag_id|整数|説明を取得するタグの ID|オプション|現在クエリされているタグ。}}
 +
 
 +
<div id="Return Values">
 +
== 戻り値 ==
 +
</div>
 +
 
 +
{{Return||文字列|タグの説明(あれば)。}}
  
 
<div id="Example">
 
<div id="Example">
 
== 用例 ==
 
== 用例 ==
 
</div>
 
</div>
 +
 
ID が 28 のタグの説明を返します。
 
ID が 28 のタグの説明を返します。
  
  <?php echo 'Tag Description: ' . tag_description('28'); ?>
+
  <?php echo 'Tag Description: ' . tag_description( '28' ); ?>
  
<div id="Parameters">
+
<div id="Change_Log">
== パラメータ ==
+
== 変更履歴 ==
; tagID
+
</div>
: (''文字列'') 説明を返すタグの ID。デフォルトは現在クエリされているタグ。
+
 
 +
* [[Version 2.8|2.8.0]] から導入されました。
 +
 
 +
<div id="Notes">
 +
== 参考 ==
 +
</div>
 +
 
 +
* 内部で [[関数リファレンス/term description|term_description()]] を使用します。
 +
* 出力は <code><nowiki><p></nowiki></code> タグで囲まれます。
 +
 
 +
<div id="Source_File">
 +
== ソースファイル ==
 +
</div>
 +
 
 +
<tt>tag_description()</tt> は {{Trac|wp-includes/category-template.php}} にあります。
  
 
<div id="Related">
 
<div id="Related">
== 関連 ==
+
== 関連項目 ==
 
</div>
 
</div>
{{Tag Tag Tags}}
 
  
{{PHP Function Tag Footer}}
+
{{Tag Tag Tags}}
  
{{Stub}}
+
{{Tag Footer}}
  
{{原文|Template Tags/tag_description|69841}}<!-- 13:20, April 15, 2009 MichaelH 版 -->
+
{{原文|Function Reference/tag_description|128264}} <!-- 17:31, 5 March 2013 Adam.samec 版 -->
  
 
{{DEFAULTSORT:Tag_description}}
 
{{DEFAULTSORT:Tag_description}}
[[Category:wp2.8]]
+
[[Category:テンプレートタグ]]
  
 
[[en:Template Tags/tag_description]]
 
[[en:Template Tags/tag_description]]
 +
[[tr:Tema_Etiketleri/tag_description]]

2014年8月10日 (日) 18:31時点における最新版

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最新版との差分