get_term()

get_term() 関数の概要

get_term()関数は、WordPressのデータベースから特定のターム(用語)情報を取得するための関数です。この関数を使用することで、タクソノミー(分類)内の指定されたタームIDに基づいて、そのタームの詳細情報を取得できます。取得したターム情報には、タームID、名前、スラッグ、説明、親タームID、カウントなどが含まれます。特定のターム情報を表示したり操作したりする際に便利です。

パラメータの説明

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

  • $term (int|string) – 必須: 取得したいタームのIDまたはスラッグを指定します。
  • $taxonomy (string) – 必須: 取得したいタームが属するタクソノミーの名前を指定します。
  • $output (string) – オプション: 取得するデータの形式を指定します。’OBJECT’(デフォルト)、’ARRAY_A’、’ARRAY_N’のいずれかを指定できます。
  • $filter (string) – オプション: フィルタを指定します。デフォルトは ‘raw’ です。

使用例

以下は、get_term()関数を使用して特定のターム情報を取得し、表示する例です:

<?php
$term_id = 123; // 取得したいタームのID
$taxonomy = 'category'; // タクソノミーの名前
$term = get_term($term_id, $taxonomy);

if (!is_wp_error($term)) {
    echo 'ターム名: ' . $term->name . '<br>';
    echo 'タームスラッグ: ' . $term->slug . '<br>';
    echo 'ターム説明: ' . $term->description . '<br>';
    echo '親タームID: ' . $term->parent . '<br>';
    echo '投稿数: ' . $term->count . '<br>';
} else {
    echo 'タームの取得に失敗しました: ' . $term->get_error_message();
}
?>

この例では、IDが123のターム情報を ‘category’ タクソノミーから取得し、その詳細を表示しています。

関連する関数

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