single_cat_title() 関数の概要
single_cat_title()
関数は、カテゴリアーカイブページで現在のカテゴリ名を表示するためのWordPress関数です。この関数を使用することで、カテゴリアーカイブページのタイトル部分にカテゴリ名を簡単に表示することができます。また、エコーせずにカテゴリ名を返すオプションも提供しています。カテゴリアーカイブページだけでなく、カスタムテンプレートなどでカテゴリ名を表示する際にも便利です。
パラメータの説明
single_cat_title()
関数には、以下のパラメータを設定することができます:
$prefix
(string) – オプション: カテゴリ名の前に表示するテキストを指定します。デフォルトは空文字列です。$display
(bool) – オプション: カテゴリ名を表示するかどうかを指定します。true
(デフォルト)で表示し、false
で返り値としてカテゴリ名を取得します。
使用例
以下は、single_cat_title()
関数を使用して現在のカテゴリアーカイブページでカテゴリ名を表示する例です:
<?php
single_cat_title('カテゴリー: '); // 'カテゴリー: 'を前置してカテゴリ名を表示
?>
この例では、現在のカテゴリ名を “カテゴリー: ” というプレフィックスとともに表示します。
カテゴリ名を返り値として取得し、後で使用する例も以下に示します:
<?php
$category_title = single_cat_title('', false); // カテゴリ名を取得
echo '現在のカテゴリ: ' . $category_title; // カテゴリ名を表示
?>
この例では、カテゴリ名を変数に格納し、後でカスタムメッセージとともに表示しています。
関連する関数
get_the_category()
: 現在の投稿に関連付けられたカテゴリ情報を配列として取得するための関数です。the_category()
: 現在の投稿に関連付けられたカテゴリをリンク付きで表示するための関数です。get_category()
: 特定のカテゴリ情報を取得するための関数です。wp_list_categories()
: カテゴリのリストを生成し、リンク付きで出力するための関数です。