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

説明

WP_Taxonomy は、タクソノミーの設定情報を表すクラスです。get_taxonomy() が返します。

基本構文

WP_Taxonomy

引数

  • name:タクソノミー名
  • label:表示名
  • hierarchical:階層構造か
  • object_type:対象の投稿タイプ

戻り値

WP_Taxonomy オブジェクト。

使い方(サンプル)

$tax = get_taxonomy( 'category' );
if ( $tax ) {
	echo esc_html( $tax->label );
}

注意点

  • 存在しないタクソノミーでは false が返ります。

実務での使いどころ

  • タクソノミーの、設定(ラベル、階層の有無、対象の投稿タイプ)を、取得するとき(get_taxonomy() の戻り値)。

よくあるミスと対処

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

NG例

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

OK例

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

使い分け早見表

やりたいこと 使うもの
タクソノミーの設定を、読み取る WP_Taxonomy のプロパティ
タクソノミーを取得する get_taxonomy()
タクソノミーを登録する register_taxonomy()

関連項目

get_taxonomy()、register_taxonomy()

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

コメント

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