single_cat_title() 関数は、カテゴリーアーカイブのページタイトルを表示または取得する関数です。
目次
single_cat_title() 関数とは
カテゴリーアーカイブページのタイトルを表示するために用意された関数です。カテゴリーテンプレートファイル category.php で利用すると便利です。
パラメーターの $prefix には自動的にスペースが入らないので、必要であれば任意で調節する必要があります。
パラメーター
$prefix | タイトルの前に表示したいものを設定 |
$display | 出力するかどうかを設定false の場合は文字列を返す |
使い方
一般的な使い方としては、category.php の中で以下にように記述することでアーカイブタイトルを出力できます。
single_cat_title();また、タイトルの前に出力したい任意の文言を、第一引数に設定することで表示できます。
single_cat_title( 'カテゴリーアーカイブタイトル：' );第二引数に false を設定することで値を返します。以下のコードで検証ができます。
$single_cat_title = single_cat_title( 'カテゴリーアーカイブタイトル：', false );
echo '<hr>' . basename(__FILE__) . ' :: ' . __LINE__;
echo( '<pre>' );
var_dump( $single_cat_title );
echo( '</pre>' );
echo '<hr>';一部の WordPress 標準テーマの中では、このように使われているケースもありました。
printf( __( 'Category Archives: %s', 'twentyfourteen' ), single_cat_title( '', false ) );フック
ありません。
まとめ
近年の WordPress 標準テーマでは、あまり活用されてはいないみたいですが、過去には Twenty Twenty-Ten や Twenty Twenty-Twelve、Twenty Fourteen といったテーマの中で活用されていたようです。
