the_terms()

the_terms() 関数の概要

the_terms()関数は、WordPressのデータベースから特定の投稿に関連付けられたターム(用語)をリンク付きで表示するための関数です。この関数を使用することで、指定した投稿IDに関連するタームをリンク付きでリスト表示することができます。カテゴリ、タグ、カスタムタクソノミーなど、さまざまなタームを表示する際に便利です。各タームは指定した区切り文字で区切られ、HTML形式で出力されます。

パラメータの説明

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

  • $post_id (int) – 必須: タームを表示したい投稿のIDを指定します。
  • $taxonomy (string) – 必須: タームが属するタクソノミーの名前を指定します。
  • $before (string) – オプション: タームリストの前に表示するテキストを指定します。デフォルトは空文字列です。
  • $sep (string) – オプション: 各タームの間に挿入する区切り文字を指定します。デフォルトは ‘, ‘(カンマとスペース)です。
  • $after (string) – オプション: タームリストの後に表示するテキストを指定します。デフォルトは空文字列です。

使用例

以下は、the_terms()関数を使用して特定の投稿に関連付けられたカテゴリをリンク付きで表示する例です:

<?php
$post_id = 123; // 表示したい投稿のID
$taxonomy = 'category'; // タクソノミーの名前
$before = 'カテゴリー: '; // リストの前に表示するテキスト
$sep = ', '; // ターム間の区切り文字
$after = ''; // リストの後に表示するテキスト

the_terms($post_id, $taxonomy, $before, $sep, $after);
?>

この例では、IDが123の投稿に関連付けられたカテゴリをリンク付きで表示し、リストの前に “カテゴリー: ” というテキストを追加しています。

関連する関数

  • get_the_terms(): 投稿に関連付けられたターム情報を取得するための関数です。
  • the_category(): 現在の投稿に関連付けられたカテゴリをリンク付きで表示するための関数です。
  • get_term(): 特定のターム情報を取得するための関数です。
  • get_terms(): 特定のタクソノミー内のターム一覧を取得するための関数です。
  • get_term_link(): 特定のタームのURLを取得するための関数です。