get_term_meta() の使い方|説明・引数・注意点

説明

get_term_meta() は、ターム(カテゴリー・タグなど)のメタデータを取得する関数です。

基本構文

get_term_meta( int $term_id, string $key = '', bool $single = false ): mixed

引数

  • $term_id:タームID
  • $key:メタキー
  • $single:単一の値で返すか

戻り値

メタの値。

使い方(サンプル)

echo esc_html( get_term_meta( 5, 'color', true ) );

注意点

  • WordPress 4.4 以降で利用できます。

実務での使いどころ

  • カテゴリーやタームごとの、追加情報(色、アイコン、並び順など)を取得するとき。

よくあるミスと対処

  • 第3引数 $single を指定せず、配列が返ってくる。既定は false で、値は配列で返る。
  • WordPress 4.4より前のバージョンでは、使えない。
  • 出力時に、エスケープしていない。

NG例

echo get_term_meta( $term_id, 'color' ); // 「Array」と表示される

OK例

echo esc_attr( get_term_meta( $term_id, 'color', true ) );

使い分け早見表

関数 役割
get_term_meta() タームのメタを取得する
update_term_meta() 値を保存する
delete_term_meta() 値を削除する

関連項目

update_term_meta()、get_post_meta()

公式リファレンス:get_term_meta() | Function | WordPress Developer Resources

コメント

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