WEB制作のための情報サイト / unazuki Library

single_term_title()

基本構文と使い方(引数・実行結果)

基本構文

ターム別の記事一覧ページ(taxonomy.phpやarchive.phpなど)にて、現在のカテゴリー名を表示します。

single_term_title($prefix,$display)

引数($post)

引数必須/任意引数に指定するもの
第1引数
$prefix
任意ターム名の前に表示する文字列
初期値''(空の文字列)
第2引数
$display
任意表示するならtrue、取得するならfalse
初期値true

実行結果

ターム名を表示します(echoする)。
※第2引数次第では取得します(戻り値を返す)

例1.taxonomy.phpで現在のターム名を表示する。

下記の例では、ターム名の前に「カテゴリー:」を表示します。

<?php single_term_title('カテゴリー:'); ?>

結果例:カテゴリー:WordPressについて
※「WordPressについて」というターム名の場合

例2.ターム名を取得して変数に格納する

下記の例では、ターム名を取得して変数に渡しています。以降の処理でターム名を使った処理をしたい場合に使うことができます。(例では単純にechoしているだけです)

<?php
$term_name = single_term_title('', false);
echo $term_name;
?>

学習者向け補足情報

【引数とは】
テンプレートタグ(=関数)を実行する際に、引数を渡すことができるテンプレートタグがあります。引数は、関数の中で使われるので、渡す引数の値によって実行結果が変わってきます。何を処理したいのか、どのようなデータを取得したいのかによって渡す引数が変わります。

【引数について】

  • 指定できる引数の数はテンプレートタグによって異なります。(引数なしもあり)
  • 引数ごとに必須 / 任意が決まっています。(必須は必ず指定、任意は指定しなければ初期値)
  • 引数名(例:$post)は仕様の便宜上の名前と考えてください。(この名前自体はテンプレートタグ実行に関係しません。各引数に何を指定するのかを理解していればOKです。)

よくある使い方

taxonomy.phpやarchive.phpなど、ターム別の記事一覧ページで現在のターム名を表示したい際によく使います。

※当サイトでは初期値とデフォルト値の言葉の定義を区別せず、原則統一して初期値を採用しています。

関連するテンプレートタグ

テンプレートタグ 説明
single_cat_title() カテゴリー別の記事一覧ページ(category.phpやarchive.phpなど)にて、現在のカテゴリー名を表示します。
get_the_terms() 投稿に紐づいているターム情報を取得します。
get_the_tags() 投稿に紐づいているタグ情報を取得します。
get_the_category() 投稿に紐づいているカテゴリー情報を取得します。
get_terms() 条件にマッチしたタームオブジェクトの配列を取得します。
get_tags() 条件にマッチしたタグオブジェクトの配列を取得します。
get_categories() 条件にマッチしたカテゴリーオブジェクトの配列を取得します。
get_term_link() タームのURLを取得します。
get_tag_link() タグのURLを取得します。
get_category_link() カテゴリーのURLを取得します。