single_tag_title()
関数は、投稿タグアーカイブページのタイトルを表示または取得します。
目次
single_tag_title() 関数とは
タグページ(タグアーカイブページ)のタイトルを表示するのに便利な関数です。
第一引数でタイトルの前に出力する文言を任意で指定できますが、自動的にスペースが入らないことには注意が必要です。
パラメーター
$prefix | タイトルの前に出力したいものを設定 |
$display | true の場合は出力、false の場合は値を返します。デフォルトは true |
使い方
一般的には、タグアーカイブページ tag.php
で以下のように利用することが多いでしょう。
single_tag_title();
タイトルの前にテキストを設定することもできます。
single_tag_title( 'タグアーカイブページタイトル' );
また、第二引数を false
にして値を取得することもできます。このように検証することができます。
$single_tag_title = single_tag_title( 'タグアーカイブタイトル:', false );
echo '<hr>' . basename(__FILE__) . ' :: ' . __LINE__;
echo( '<pre>' );
var_dump( $single_tag_title );
echo( '</pre>' );
echo '<hr>';
過去の WordPress 標準テーマでは、以下のように使われているケースがあります。
printf( __( 'Tag Archives: %s', 'twentyfourteen' ), single_tag_title( '', false ) );
フック
ありません。
まとめ
最近の WordPress 標準テーマ(クラシックテーマの中)ではあまり利用されていないようですが、過去には Twenty Ten、Twenty Eleven、Twenty Twelve、Twenty Thirteen、Twenty Fourteen などの中で利用されています。