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

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

提供: WordPress Codex 日本語版
移動先: 案内検索
(2006年8月に作成した翻訳データの流し込み(暫定版、要フォーマット))
 
 
(3人の利用者による、間の3版が非表示)
1行目: 1行目:
★category_description
+
<div id="Description">
* 書式: <?php category_description(category); ?>
+
== 説明 ==
* 説明: カテゴリー管理画面で設定したカテゴリーの説明をPHPの値として返す。
+
</div>
* 位置: ループ外
+
 
* 引数:
+
現在のカテゴリーについて、カテゴリー管理画面(投稿 &gt; カテゴリー)で設定した「カテゴリーの説明」を返します。
** category(整数)- 数字のカテゴリーID。指定しない場合、現在のページのカテゴリーIDが自動で割り当てられる。
+
archive.php テンプレートで使う場合、条件分岐タグ is_category() の内側で使ってください。
* コード記述例: <code><nowiki><p><?php echo category_description(2); ?></p></nowiki></code>
+
そうしないと、月別アーカイブや他のアーカイブページの処理がこの関数のところで停止してしまいます。
* 出力例: <code><nowiki><p>WordPress関連情報のカテゴリー</p></nowiki></code>
+
 
 +
<div id="Usage">
 +
== 使い方 ==
 +
</div>
 +
 
 +
<?php echo category_description( $category_id ); ?>
 +
 
 +
<div id="Parameters">
 +
== パラメータ ==
 +
</div>
 +
 
 +
{{Parameter|$category_id|整数|説明を取得するカテゴリーの ID|オプション|現在のページのカテゴリー ID}}
 +
<!-- Default: Description of current query category. -->
 +
 
 +
<div id="Example">
 +
== 用例 ==
 +
</div>
 +
<div id="Default Usage">
 +
=== デフォルトの使い方 ===
 +
</div>
 +
 
 +
ID を指定してテンプレートタグの戻り値を echo することで、カテゴリーの説明を表示します。
 +
カテゴリーを指定せずにカテゴリーアーカイブのページで使用すると、現在のカテゴリーの説明を返します。
 +
 
 +
<nowiki><div><?php echo category_description(3); ?></div></nowiki>
 +
 
 +
出力例:
 +
 
 +
<blockquote>WordPress is a favorite blogging tool of mine and I share tips and tricks for using WordPress here.</blockquote>
 +
 
 +
参考:カテゴリーの説明がない場合、このテンプレートタグは HTML の br タグを返します。
 +
 
 +
<div id="Using Category Slug">
 +
=== カテゴリーのスラッグから取得 ===
 +
</div>
 +
 
 +
カテゴリーのスラッグを指定してカテゴリーの説明を表示します。
 +
 
 +
<nowiki><?php echo category_description( get_category_by_slug('category-slug')->term_id ); ?></nowiki>
 +
 
 +
<div id="With Category Title">
 +
=== カテゴリーのタイトルと一緒に表示 ===
 +
</div>
 +
 
 +
<nowiki><div><strong><?php single_cat_title('Currently browsing'); ?>
 +
</strong>: <?php echo category_description(); ?></div></nowiki>
 +
 
 +
出力例:
 +
 
 +
<blockquote>'''Currently browsing WordPress:''' WordPress is a favorite blogging tool of mine and I share tips and tricks for using WordPress here.</blockquote>
 +
 
 +
<div id="Change Log">
 +
== 変更履歴 ==
 +
</div>
 +
 
 +
* [[Version 1.0|バージョン 1.0.0]] にて導入されました。
 +
 
 +
<div id="Notes">
 +
== 参考 ==
 +
</div>
 +
 
 +
* 内部で [[関数リファレンス/term description|term_description()]] を使用します。
 +
 
 +
<div id="Source File">
 +
== ソースファイル ==
 +
</div>
 +
 
 +
<tt>category_description()</tt> は {{Trac|wp-includes/category-template.php}} にあります。
 +
 
 +
<div id="Related">
 +
== 関連項目 ==
 +
</div>
 +
 
 +
{{Tag Category Tags}}
 +
 
 +
{{Tag Footer}}
 +
 
 +
{{原文|Template Tags/category_description|100816}} <!-- 01:34, 21 February 2011 Ramiy 版 -->
 +
 
 +
{{DEFAULTSORT:Category_description}}
 +
[[Category:テンプレートタグ]]
  
 
[[en:Template Tags/category_description]]
 
[[en:Template Tags/category_description]]
 +
[[pt-br:Referência de Função/category description]]

2014年8月5日 (火) 00:46時点における最新版

現在のカテゴリーについて、カテゴリー管理画面(投稿 > カテゴリー)で設定した「カテゴリーの説明」を返します。 archive.php テンプレートで使う場合、条件分岐タグ is_category() の内側で使ってください。 そうしないと、月別アーカイブや他のアーカイブページの処理がこの関数のところで停止してしまいます。

使い方

<?php echo category_description( $category_id ); ?>

パラメータ

$category_id
整数) (オプション) 説明を取得するカテゴリーの ID
初期値: 現在のページのカテゴリー ID

用例

デフォルトの使い方

ID を指定してテンプレートタグの戻り値を echo することで、カテゴリーの説明を表示します。 カテゴリーを指定せずにカテゴリーアーカイブのページで使用すると、現在のカテゴリーの説明を返します。

<div><?php echo category_description(3); ?></div>

出力例:

WordPress is a favorite blogging tool of mine and I share tips and tricks for using WordPress here.

参考:カテゴリーの説明がない場合、このテンプレートタグは HTML の br タグを返します。

カテゴリーのスラッグから取得

カテゴリーのスラッグを指定してカテゴリーの説明を表示します。

<?php echo category_description( get_category_by_slug('category-slug')->term_id ); ?>

カテゴリーのタイトルと一緒に表示

<div><strong><?php single_cat_title('Currently browsing'); ?>
</strong>: <?php echo category_description(); ?></div>

出力例:

Currently browsing WordPress: WordPress is a favorite blogging tool of mine and I share tips and tricks for using WordPress here.

変更履歴

参考

ソースファイル

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


カテゴリータグ: the_category(), the_category_rss(), single_cat_title(), category_description(), wp_dropdown_categories(), wp_list_categories(), get_the_category(), get_the_category_by_ID(), get_category_by_slug(), get_the_category_list(), get_category_parents(), get_category_link(), is_category(), in_category()


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


最新英語版: WordPress Codex » Template Tags/category_description最新版との差分