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

説明

get_taxonomy() は、タクソノミー名から、タクソノミーの設定情報を取得する関数です。

基本構文

get_taxonomy( string $taxonomy ): WP_Taxonomy|false

引数

  • $taxonomy:タクソノミー名

戻り値

WP_Taxonomy。存在しなければ false。

使い方(サンプル)

$tax = get_taxonomy( 'genre' );
if ( $tax ) {
	var_dump( $tax->label );
}

注意点

  • 存在しない場合は false が返るため、判定してから使います。

実務での使いどころ

  • タクソノミーの、表示名(ラベル)や、設定を取得するとき。
  • 登録されたタクソノミーが、階層ありかなどを、確認するとき。

よくあるミスと対処

  • 存在しないタクソノミーでは false が返る。確認せずにプロパティへアクセスする。
  • ラベルを、直接 $tax->name から取っている。表示名は、$tax->labels->name や $tax->label。

NG例

$tax = get_taxonomy( 'news_cat' );
echo $tax->name; // スラッグであり、表示名ではない

OK例

$tax = get_taxonomy( 'news_cat' );
if ( $tax ) {
	echo esc_html( $tax->labels->name );
}

使い分け早見表

やりたいこと 使うもの
1つのタクソノミーの情報 get_taxonomy()
タクソノミーの一覧 get_taxonomies()
タクソノミーがあるか確認 taxonomy_exists()

関連項目

get_taxonomies()、register_taxonomy()

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

コメント

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