プラグインCustom Post Type UIのcptui_get_taxonomy_data関数の使用方法・解説

概要

cptui_get_taxonomy_data 関数は、WordPressのCustom Post Type UIプラグインで使用される関数で、特定のカスタムタクソノミーに関するデータを取得します。この関数は、カスタムタクソノミーを設定する際に便利であり、以下のような機能を実装する際に頻繁に利用されます。

カスタムタクソノミーの情報を取得したい場合
タクソノミーのラベルやオプションをカスタマイズしたい場合
投稿やページに関連するタクソノミーデータを表示したい場合
テーマやプラグインでタクソノミーの管理機能を強化したい場合
REST APIを通じてタクソノミーデータを取得したい場合
フロントエンドでタクソノミーのフィルタリング機能を実装したい場合

構文

cptui_get_taxonomy_data( $taxonomy );

パラメータ

$taxonomy (string): 取得したいタクソノミーのスラッグ。

戻り値

(array): 指定したタクソノミーに関するデータの配列。

バージョン

Custom Post Type UIのバージョン: 1.10.0以降
WordPressのバージョン: 4.5以降

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

アクション	使用可能性
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

$taxonomy_data = cptui_get_taxonomy_data( 'custom_taxonomy' );
echo '<pre>' . print_r( $taxonomy_data, true ) . '</pre>';

このコードは、’custom_taxonomy’というタクソノミーのデータを取得し、フォーマットして表示します。

サンプルコード 2

$taxonomy_slug = 'category';
$taxonomy_info = cptui_get_taxonomy_data( $taxonomy_slug );

if ( ! empty( $taxonomy_info['labels']['name'] ) ) {
    echo 'Taxonomy Name: ' . esc_html( $taxonomy_info['labels']['name'] );
}

このコードは、’category’というデフォルトタクソノミーの名前を取得して表示します。

サンプルコード 3

$taxonomy = 'my_custom_taxonomy';
$data = cptui_get_taxonomy_data( $taxonomy );

if ( ! empty( $data ) ) {
    foreach ( $data['labels'] as $label => $value ) {
        echo ucfirst( $label ) . ': ' . esc_html( $value ) . '<br>';
    }
}

このコードは、指定されたカスタムタクソノミーのすべてのラベルとその値を列挙して表示します。

サンプルコード 4

function get_custom_taxonomy_terms() {
    $terms = cptui_get_taxonomy_data( 'portfolio_category' );
    return $terms['hierarchical'] ? 'これは階層型タクソノミーです。' : 'これは非階層型タクソノミーです。';
}
echo get_custom_taxonomy_terms();

このコードは、’portfolio_category’というカスタムタクソノミーが階層型かどうかを判別し、その結果を表示します。

サンプルコード 5

function display_custom_taxonomy_terms() {
    $taxonomy_data = cptui_get_taxonomy_data( 'custom_genre' );
    if ( ! empty( $taxonomy_data['labels']['singular_name'] ) ) {
        echo 'Singular Name: ' . esc_html( $taxonomy_data['labels']['singular_name'] );
    }
}
add_action( 'wp_footer', 'display_custom_taxonomy_terms' );

このコードは、カスタムタクソノミーの単数名をフッターに表示するためのフックを使用しています。

これらのサンプルコードはすべて著作権フリーのものであり、どのように cptui_get_taxonomy_data 関数を使用できるかを示しています。

概要

構文