get_the_category_list()

get_the_category_list() 関数の概要

get_the_category_list()関数は、現在の投稿に関連付けられたカテゴリをリスト形式で取得するためのWordPress関数です。この関数を使用することで、特定の投稿が所属するカテゴリをリンク付きのリストとして取得できます。各カテゴリは指定した区切り文字で区切られ、HTML形式で返されます。主に投稿のメタ情報やナビゲーションリンクとしてカテゴリを表示する際に便利です。

パラメータの説明

get_the_category_list()関数には、以下のパラメータを設定することができます:

  • $separator (string) – オプション: 各カテゴリの間に挿入する文字列を指定します。デフォルトは空文字列です。
  • $parents (string) – オプション: 親カテゴリの表示方法を指定します。’multiple’(デフォルト)、’single’、または’なし’を指定できます。
  • $post_id (int) – オプション: カテゴリを取得したい投稿のIDを指定します。省略した場合、現在の投稿のカテゴリが取得されます。

使用例

以下は、get_the_category_list()関数を使用して現在の投稿に関連付けられたカテゴリのリンク付きリストを取得し、表示する例です:

<?php
$separator = ', '; // カテゴリをカンマで区切る
$category_list = get_the_category_list($separator);

if ($category_list) {
    echo 'カテゴリ: ' . $category_list;
} else {
    echo 'この投稿にはカテゴリがありません。';
}
?>

この例では、現在の投稿に関連付けられたカテゴリをカンマで区切って表示しています。

関連する関数

  • the_category(): 現在の投稿に関連付けられたカテゴリをリンク付きで表示するための関数です。
  • get_the_category(): 現在の投稿に関連付けられたカテゴリ情報を配列として取得するための関数です。
  • get_category(): 特定のカテゴリ情報を取得するための関数です。
  • wp_list_categories(): カテゴリのリストを生成し、リンク付きで出力するための関数です。