プラグインWooCommerceのwoocommerce_taxonomy_args_product_typeフィルタの使用方法・解説

概要

woocommerce_taxonomy_args_product_typeはWooCommerceにおけるフィルタの一つで、商品のタイプに関連するタクソノミーの引数を変更するために使用されます。このフィルタを利用することで、商品タイプの動作や表示方法をカスタマイズすることが可能です。具体的には、以下のような機能を実装する際によく使われます。

商品タイプの選択肢をカスタマイズする
商品タイプに基づいて表示されるカスタムフィールドを追加する
商品タイプに関連する税金設定を変更する
特定の商品タイプに依存したカスタムメタデータの追加
商品タイプによって異なる情報をフィルタリングする
商品タイプに基づくクエリの調整

構文

add_filter( 'woocommerce_taxonomy_args_product_type', 'your_custom_function' );
function your_custom_function( $args ) {
    // カスタマイズしたい引数を操作
    return $args;
}

パラメータ

$args: 変更可能な配列。タクソノミーの引数が格納されている。

戻り値

$args: 変更後のタクソノミー引数を返す。

使用可能なプラグイン/ワードプレスのバージョン

WooCommerce: 3.0以降
WordPress: 4.0以降

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

アクション	使用可能性
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: 商品タイプの選択肢を追加

このコードは、新しい商品タイプを追加するためのサンプルです。

add_filter( 'woocommerce_taxonomy_args_product_type', 'add_custom_product_type' );
function add_custom_product_type( $args ) {
    $args['hierarchical'] = false; // 階層を無効にする
    return $args;
}

引用元: https://docs.woocommerce.com/document/customizing-woocommerce-product-types/

サンプル2: 商品タイプのラベルを変更

このコードは、特定の商品のラベルを変更するサンプルです。

add_filter( 'woocommerce_taxonomy_args_product_type', 'change_custom_product_type_label' );
function change_custom_product_type_label( $args ) {
    $args['labels']['name'] = 'Custom Products'; // ラベル名を変更
    return $args;
}

引用元: https://woocommerce.github.io/code-reference/classes/WC-Taxonomy.html

サンプル3: 商品タイプのメタデータを追加

このコードは、商品タイプに基づいてカスタムメタデータを追加するサンプルです。

add_filter('woocommerce_taxonomy_args_product_type', 'add_meta_to_custom_product_type' );
function add_meta_to_custom_product_type( $args ) {
    $args['show_in_rest'] = true; // REST APIで表示する
    return $args;
}

引用元: https://developer.wordpress.org/reference/hooks/

サンプル4: 特定の条件で商品タイプをフィルタリング

このコードは、特定の条件下で商品タイプをフィルタリングするサンプルです。

add_filter( 'woocommerce_taxonomy_args_product_type', 'filter_product_type' );
function filter_product_type( $args ) {
    if ( is_user_logged_in() ) {
        $args['public'] = true; // ログイン時に商品タイプを公開
    } else {
        $args['public'] = false; // 非公開
    }
    return $args;
}

引用元: https://woocommerce.com/document/create-a-custom-product-type/

サンプル5: ウェブサイト全体で商品タイプをカスタマイズ

このコードは、ウェブサイト全体で商品タイプをカスタマイズするサンプルです。

add_filter( 'woocommerce_taxonomy_args_product_type', 'global_customization_product_type' );
function global_customization_product_type( $args ) {
    $args['show_admin_column'] = true; // 管理画面での列を表示
    return $args;
}

引用元: https://www.smashingmagazine.com/2020/11/customizing-woocommerce-product-types/

概要

構文