single_term_title()
は、カスタム分類(taxonomy)アーカイブページやカテゴリー、タグなどのタームページで、現在のターム名を取得・表示するためのテンプレートタグです。
機能の説明
single_term_title()
は、カスタムタクソノミーのアーカイブページやタグ、カテゴリーのページで、そのタームのタイトル(名前)を表示するために使われます。タームは、分類システム(タクソノミー)に属する要素で、カテゴリーやタグ、カスタムタクソノミーを指します。
シンプルなコード例
single_term_title();
このコードは、現在のタームアーカイブページに表示されているターム名を出力します。
使い方の解説
single_term_title()
は、タクソノミーやタグ、カテゴリーアーカイブページで現在のタームの名前を表示するために使用されます。プレフィックス(表示する前に追加するテキスト)を設定する場合は、引数を指定します。
使用例
<h1><?php single_term_title( 'ターム: ' ); ?></h1>
このコードでは、<h1>
タグ内に「ターム: ターム名」という形式で、現在のタームアーカイブページのタイトルが表示されます。例えば、ターム「ニュース」のページでは、「ターム: ニュース」というタイトルが表示されます。
一緒に使うことが多い関連タグ
get_term()
get_term()
は、指定したタームの詳細情報を取得するテンプレートタグです。single_term_title()
と組み合わせてタームに関する追加情報を取得するのに便利です。
使用例
$term = get_term( get_queried_object_id() );
echo $term->name; // ターム名を出力
echo $term->slug; // タームのスラッグを出力
echo $term->description; // タームの説明を出力
このコードは、現在のターム情報(名前、スラッグ、説明など)を取得して表示します。get_term()
を使うと、single_term_title()
で取得できない追加情報も表示できます。
get_the_terms()
get_the_terms()
は、特定の投稿に紐付けられたタームを取得するために使われます。主にカスタムタクソノミーやタグ、カテゴリーを扱う際に使用します。
使用例
$terms = get_the_terms( get_the_ID(), 'taxonomy_name' );
if ( $terms && ! is_wp_error( $terms ) ) {
foreach ( $terms as $term ) {
echo '<a href="' . get_term_link( $term ) . '">' . $term->name . '</a> ';
}
}
このコードは、特定の投稿に紐付けられたターム(カスタムタクソノミーなど)を取得し、リンク付きで表示します。タクソノミーの名前を変更すれば、任意のタクソノミーで利用可能です。
追加情報を取得したい場合
get_term_meta()
で取得できる情報
get_term_meta()
は、特定のタームのメタデータを取得するテンプレートタグです。タームにカスタムメタデータが設定されている場合に、その値を取得することができます。
ソースコード例
$term_id = get_queried_object_id();
$custom_meta = get_term_meta( $term_id, 'custom_meta_key', true );
echo $custom_meta;
出力できる情報
- meta_key: タームに紐付いたカスタムメタデータのキー
- meta_value: メタデータの値
想定されるトラブル
タームが表示されない
タームアーカイブページ以外のページで single_term_title()
を使用している可能性があります。
解決方法
このテンプレートタグはタームアーカイブページ専用なので、is_tax()
などの条件文を使ってタクソノミーのページかどうかを確認してください。
プレフィックスが表示されない
single_term_title()
の引数が正しく設定されていない可能性があります。
解決方法
プレフィックス(例えば「ターム: 」など)を表示するには、single_term_title( 'プレフィックス: ' )
のように引数を設定します。
Q&A
まとめ
single_term_title()
は、カスタムタクソノミーやカテゴリー、タグなどのアーカイブページで、現在表示されているターム名を取得・表示するための非常に便利なテンプレートタグです。関連するタグと組み合わせて使用することで、より柔軟なタクソノミーの管理と表示が可能になります。
コメント