
目次
single_term_title()の用途
single_term_title()
は、カテゴリー・タグ・カスタムタクソノミーのアーカイブページで、その現在表示されているターム(用語)のタイトルを出力するテンプレートタグです。
ターム(Term)とは、カテゴリーやタグ、カスタム分類の各項目を指します。
たとえば、
- 「カテゴリー: ニュース」
- 「タグ: キャンペーン」
- 「カスタムタクソノミー: 地域=東京」
といった一覧ページで、その「ニュース」や「キャンペーン」「東京」の名前を表示できます。
single_term_title()の基本構文
single_term_title( string $prefix = '', bool $display = true )
single_term_title()のパラメータ
パラメータ | 説明 |
---|---|
$prefix | 表示する前に付ける文字列(接頭辞)。例:「カテゴリー: 」など。 |
$display | true なら表示する(エコー)、false なら返すだけ(return)。 |
single_term_title()の使い方の例
1. 単純に現在のターム名を出力
single_term_title();
→「ニュース」など、そのターム名が表示されます。
2. 接頭辞をつけて表示
single_term_title('カテゴリー: ');
→「カテゴリー: ニュース」と表示。
3. 返り値として取得
$term_title = single_term_title('', false);
echo '現在のタームは「' . $term_title . '」です。';
→ single_term_title()
は display = false
のとき文字列を返すので、自由に加工できます。
single_term_title()
と似たタグとの違い
関数 | 役割 |
---|---|
single_term_title() | 現在のタームタイトルのみ表示・取得。接頭辞をつけられる。 |
single_cat_title() | 現在のカテゴリータイトルのみ表示・取得。タグやカスタムタクソノミーには使えない。 |
single_tag_title() | 現在のタグタイトルのみ表示・取得。 |
get_queried_object() | 現在のタームオブジェクト(IDやスラッグなど詳細情報)を取得できる。 |
single_term_title()の活用例:ページタイトルに動的表示
archive.php
やtaxonomy.php
で、ターム名をタイトルに入れる例:
<h1>
<?php single_term_title(); ?> の記事一覧
</h1>
「ニュース の記事一覧」などと表示されます。
single_term_title()の注意点
- この関数はタームアーカイブページ以外では空文字を返します。
- シングル投稿ページなどでは何も出力されません。
single_cat_title()
とsingle_tag_title()
はカテゴリー・タグ限定。- カスタムタクソノミーも一括で対応するには
single_term_title()
を使う方が便利です。
- カスタムタクソノミーも一括で対応するには
カスタムタクソノミーでも利用可能
カスタムタクソノミー(例:genre
)でも同じように使えます。
例えば taxonomy-genre.php
で
<h2><?php single_term_title(); ?>ジャンルの記事</h2>
とすれば、
「ミステリージャンルの記事」
と表示されます。
single_term_title()のまとめ
single_term_title()
のポイント
- 現在表示しているターム(カテゴリー・タグ・カスタムタクソノミー)名を表示する。
prefix
で接頭辞をつけられる。display=false
で値だけ取得できる。