single_term_title() 関数は、アーカイブページのタクソノミ名を表示または取得します。
目次
single_term_title() 関数とは
アーカイブページのタクソノミー名を取得・表示するのに便利な関数です。
第一引数でタイトルの前に出力する文言を任意で指定できますが、自動的にスペースが入らないことには注意が必要です。
パラメーター
$prefix | タイトルの前に出力したいものを設定 |
$display | true の場合は出力、false の場合は値を返します。デフォルトは true |
使い方
一般的には、アーカイブページで以下のように利用することが多いでしょう。
single_term_title();タイトルの前にテキストを設定することもできます。
single_term_title( 'タクソノミー名：' );また、第二引数を false にして値を取得することもできます。このように検証することができます。
$single_tag_title = single_term_title( 'タクソノミー名：', false );
echo '<hr>' . basename(__FILE__) . ' :: ' . __LINE__;
echo( '<pre>' );
var_dump( $single_tag_title );
echo( '</pre>' );
echo '<hr>';過去の WordPress 標準テーマでは、以下のように使われているケースがあります。
$title = __( 'Tag Archives: ', 'twentynineteen' ) . '<span class="page-description">' . single_term_title( '', false ) . '</span>';フック
single_cat_title
apply_filters( ‘single_cat_title’, string $term_name )カテゴリーアーカイブページタイトル名にフィルターできます。以下のコードで検証できます。
add_filter(
'single_cat_title',
function ( $term_name ) {
echo '<hr>' . basename(__FILE__) . ' :: ' . __LINE__;
echo( '<pre>' );
var_dump( $term_name );
echo( '</pre>' );
echo '<hr>';
return $term_name;
},
10,
1
);single_tag_title
apply_filters( ‘single_tag_title’, string $term_name )タグアーカイブページタイトル名にフィルターできます。以下のコードで検証できます。
add_filter(
'single_tag_title',
function ( $term_name ) {
echo '<hr>' . basename(__FILE__) . ' :: ' . __LINE__;
echo( '<pre>' );
var_dump( $term_name );
echo( '</pre>' );
echo '<hr>';
return $term_name;
},
10,
1
);single_term_title
apply_filters( ‘single_term_title’, string $term_name )カスタムタクソノミーアーカイブページタイトル名にフィルターできます。以下のコードで検証できます。
add_filter(
'single_term_title',
function ( $term_name ) {
echo '<hr>' . basename(__FILE__) . ' :: ' . __LINE__;
echo( '<pre>' );
var_dump( $term_name );
echo( '</pre>' );
echo '<hr>';
return $term_name;
},
10,
1
);まとめ
あまり最近のテーマには利用されなくなってきているかもしれませんが、過去に作成されたテーマのメンテナンス作業などの際には目にすることもまだまだあるでしょう。しっかりと確認しておきたいところです。
