ワードプレスのget_term関数の使用方法・解説

概要

get_term関数は、WordPress内でカテゴリやタグなどのタクソノミー項目の詳細情報を取得する際に使用されます。この関数は、特定のIDを指定して、そのタクソノミー項目に関連する情報を取得します。以下のような機能を実装する際に特によく使用されます。

1. 投稿の表示に関する情報取得
2. カテゴリ別のナビゲーションメニューの作成
3. タグクラウドやカテゴリリストのカスタマイズ
4. カスタムタクソノミーのターム情報を取得
5. タームに関連するメタデータの利用
6. SEO対策のためのターム情報取得
7. 使用しているテーマのカスタマイズ
8. プラグイン開発において、ターム情報を元にした機能追加

構文

get_term( int $term_id, string $taxonomy, array $args = array() )

パラメータ

• $term_id (int) — タームのID。
• $taxonomy (string) — タクソノミー名（例: ‘category’, ‘post_tag’など）。
• $args (array) — 追加の引数（オプション）。

戻り値

get_term関数は、指定したタームのオブジェクトを返します。このオブジェクトには、タームの名称、スラッグ、メタデータなどが含まれています。

関連する関数

• get_terms
• wp_get_post_terms
• get_term_meta

使用可能なバージョン

get_term関数は、WordPress 3.0以降で使用可能です。

コアファイルのパス

wp-includes/taxonomy.php

この関数のアクションでの使用可能性

アクション	使用可能性
mu_plugin_loaded	〇
registered_post_type
plugins_loaded	〇
wp_roles_init
setup_theme
after_setup_theme	〇
set_current_user
init	〇
register_sidebar
wp_loaded	〇
send_headers
parse_query
pre_get_posts	〇
wp	〇
template_redirect	〇
get_header
wp_head

サンプルコード

1. IDを指定して特定のカテゴリ情報を取得

   $category = get_term(1, 'category');
   echo $category->name; // カテゴリ名を出力
   

   このコードは、IDが1のカテゴリ情報を取得し、その名前を出力します。

2. カスタムタクソノミーのタームを取得

   $custom_term = get_term(2, 'custom_taxonomy');
   echo $custom_term->description; // タームの説明を出力
   

   このコードは、カスタムタクソノミーのIDが2のタームの説明を取得し出力します。

3. タクソノミー一覧からの情報取得

   $tags = get_term(3, 'post_tag');
   echo $tags->slug; // タグのスラッグを出力
   

   タグタクソノミーのIDが3のタームのスラッグを取得して出力します。

4. タームのメタデータを取得

   $term_meta = get_term_meta(4, 'my_meta_key', true);
   echo $term_meta; // メタデータを出力
   

   このコードは、IDが4のタームの特定のメタデータを取得し出力します。

5. 存在しないタームを取得した場合の処理

   $term = get_term(9999, 'category');
   if (is_wp_error($term)) {
      echo '指定したタームは存在しません。';
   }
   

   このコードは、存在しないタームのIDを指定した場合にエラー処理を行います。