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

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

「テンプレートタグ/single cat title」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(1 版)
(en:Template Tags/single_cat_title 15:58, 29 April 2014 Hunterhogan 版を反映して訳を見直し。)
1行目: 1行目:
* 書式: <?php single_cat_title('prefix', 'display'); ?>
+
<div id="Description">
* 説明: 現在のページのカテゴリー名を出力。カテゴリーページ以外では無効。
+
== 説明 ==
* 位置: ループ外
+
</div>
* 引数:
+
 
** prefix (文字列)- カテゴリー名の前に出力するテキスト。デフォルトでは空。
+
[[用語集#Category|カテゴリー]]または[[用語集#Tag|タグ]]アーカイブが[[用語集#Query|クエリ]]されているときに使用すると、ページタイトル(カテゴリー名またはタグ名)を表示または返します。
** display (true/false)- 取得した値の処理方法。
+
従って、この関数が使えるのは[[ループ]]の外側においてのみです。
*** true(デフォルト。カテゴリー名をページ内に出力)
+
 
*** false(PHPで使用できる値としてカテゴリー名を返す)
+
<div id="Usage">
* コード記述例: <code><nowiki><p><?php single_cat_title('カテゴリー: '); ?></p></nowiki></code>
+
== 使い方 ==
* 出力例: <code><nowiki><p>カテゴリー: WordPress</p></nowiki></code>
+
</div>
 +
 
 +
<?php single_cat_title( $prefix, $display ); ?>
 +
 
 +
<div id="Default Usage">
 +
=== デフォルトの使い方 ===
 +
</div>
 +
 
 +
<nowiki><pre><?php single_cat_title( '', true ); ?></pre></nowiki>
 +
 
 +
<div id="Parameters">
 +
== パラメータ ==
 +
</div>
 +
 
 +
{{Parameter|$prefix|文字列|タイトルの前に出力するテキスト。|オプション}}
 +
参考:引数 $prefix は、引数 $display が false のときには無視されます。<br />
 +
http://core.trac.wordpress.org/ticket/16632 を参照してください。
 +
{{Parameter|$display|真偽値|ページタイトルを表示する(''true'')か、それとも PHP で使うために返す(''false'')。|オプション|true}}
 +
 
 +
<div id="Return Values">
 +
== 戻り値 ==
 +
</div>
 +
 
 +
{{Return||文字列&#124;void|カテゴリーまたはタグアーカイブが[[用語集#Query|クエリ]]されており、かつ <tt>$display</tt> が ''false'' のとき、ページタイトルを返す。}}
 +
 
 +
<div id="Examples">
 +
== 用例 ==
 +
</div>
 +
 
 +
下記の例はテキスト "'''Currently browsing '''" に続けてカテゴリータイトルを表示します。
 +
 
 +
<nowiki><p><?php single_cat_title('Currently browsing '); ?>.</p></nowiki>
 +
 
 +
<div style="border:1px solid blue; width:50%; padding:10px">Currently browsing WordPress.</div>
 +
 
 +
下記の例は変数 $current_category に現在のカテゴリータイトルをセットして PHP で使えるようにします。
 +
 
 +
<?php $current_category = single_cat_title("", false); ?>
 +
 
 +
<div id="Notes">
 +
== 参考 ==
 +
</div>
 +
 
 +
* [[Version 3.1|バージョン 3.1]] 以降、この関数は <tt>[[関数リファレンス/single_term_title|single_term_title()]]</tt> のエイリアスです。
 +
* [[Version 3.1|バージョン 3.1]] より前は、この関数は <tt>[[関数リファレンス/single_tag_title|single_tag_title()]]</tt> を使っていました。
 +
 
 +
<div id="Change Log">
 +
== 更新履歴 ==
 +
</div>
 +
 
 +
[[Version 0.71|バージョン 0.71]] にて導入されました。
 +
 
 +
<div id="Source File">
 +
== ソースファイル ==
 +
</div>
 +
 
 +
<tt>single_cat_title()</tt> は {{Trac|wp-includes/general-template.php}} にあります。
 +
 
 +
<div id="Related">
 +
== 関連項目 ==
 +
</div>
 +
 
 +
{{Tag Category Tags}}
 +
{{Tag Footer}}
 +
 
 +
{{原文|Template Tags/single_cat_title|143072}} <!-- 15:58, 29 April 2014 Hunterhogan 版 -->
 +
 
 +
{{DEFAULTSORT:single_cat_title}}
 +
[[Category:テンプレートタグ]]
  
 
[[en:Template Tags/single_cat_title]]
 
[[en:Template Tags/single_cat_title]]
 +
[[pt-br:Template Tags/single_cat_title]]

2014年8月4日 (月) 00:30時点における版

カテゴリーまたはタグアーカイブがクエリされているときに使用すると、ページタイトル(カテゴリー名またはタグ名)を表示または返します。 従って、この関数が使えるのはループの外側においてのみです。

使い方

<?php single_cat_title( $prefix, $display ); ?>

デフォルトの使い方

<pre><?php single_cat_title( '', true ); ?></pre>

パラメータ

$prefix
文字列) (オプション) タイトルの前に出力するテキスト。
初期値: なし

参考:引数 $prefix は、引数 $display が false のときには無視されます。
http://core.trac.wordpress.org/ticket/16632 を参照してください。

$display
真偽値) (オプション) ページタイトルを表示する(true)か、それとも PHP で使うために返す(false)。
初期値: true

戻り値

(文字列|void) 
カテゴリーまたはタグアーカイブがクエリされており、かつ $displayfalse のとき、ページタイトルを返す。

用例

下記の例はテキスト "Currently browsing " に続けてカテゴリータイトルを表示します。

<p><?php single_cat_title('Currently browsing '); ?>.</p>
Currently browsing WordPress.

下記の例は変数 $current_category に現在のカテゴリータイトルをセットして PHP で使えるようにします。

<?php $current_category = single_cat_title("", false); ?>

参考

更新履歴

バージョン 0.71 にて導入されました。

ソースファイル

single_cat_title()wp-includes/general-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/single_cat_title最新版との差分