WP_Term クラスの使い方|説明・引数・注意点

説明

WP_Term は、タクソノミーのターム(カテゴリー、タグなど)1件分のデータを表すクラスです。

基本構文

WP_Term

引数

  • term_id:タームID
  • name:名前
  • slug:スラッグ
  • taxonomy:タクソノミー名
  • description:説明
  • parent:親のターム
  • count:紐付く投稿数

戻り値

プロパティを持つオブジェクト。

使い方(サンプル)

$term = get_term( 5 );
if ( $term && ! is_wp_error( $term ) ) {
	echo esc_html( $term->name );
}

注意点

  • get_term() などは、失敗時に WP_Error を返すことがあります。
  • count は公開済み投稿の数です。

実務での使いどころ

  • タームのデータ(term_id・name・slug・taxonomy・count)を、オブジェクトとして、扱うとき。
  • get_terms() や get_the_terms() の戻り値を、読み取るとき。

よくあるミスと対処

  • term_id と term_taxonomy_id を、取り違える。get_term()・wp_set_object_terms() などが使うのは、term_id。
  • name(表示名)と slug(URL用)を、取り違える。
  • count を、投稿の総数だと考えている。公開済みの投稿の数。

NG例

echo $term->term_taxonomy_id; // IDとして使うのは term_id

OK例

echo (int) $term->term_id;
echo esc_html( $term->name );

使い分け早見表

やりたいこと 使うもの
タームのデータを、読み取る WP_Term のプロパティ
IDから取得する get_term()
一覧を取得する get_terms()

関連項目

get_term()、get_terms()、get_the_terms()

公式リファレンス:WP_Term | WordPress Developer Resources

コメント

タイトルとURLをコピーしました