テンプレートタグ/single tag title

説明

現在のページのタグタイトルを表示または取得します。 タグアーカイブページで使用します。

使い方

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

デフォルトの使い方

<?php single_tag_title(); ?>

パラメータ

$prefix

（文字列） （オプション） タグタイトルの前に出力するテキスト。

初期値： なし

参考：現状では、$display 引数が false のとき $prefix 引数は無視されます。trac チケット #16632 を参照してください。

$display

（真偽値） （オプション） タグタイトルを表示するか（TRUE）、PHP で扱えるように値として返すか（FALSE）。

初期値： TRUE

用例

最初の例は、"Currently browsing " というテキストに続けてタグタイトルを表示します。

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

Currently browsing WordPress.

次の例は、PHP で扱うために現在のタグタイトルを変数 $current_tag に代入します。

<?php $current_tag = single_tag_title( "", false ); ?>

変更履歴

• 3.1.0 から、内部で single_term_title() を使うようになりました。
• 2.3.0 から導入されました。

ソースファイル

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