プラグインWooCommerceのwoocommerce_taxonomy_objects_$TERM[domain]フィルタの使用方法・解説

概要

woocommerce_taxonomy_objects_$TERM[domain] は、WooCommerceでカスタムタクソノミーに関連するオブジェクトをフィルタリングするためのフックです。このフィルタは、特定のタームに関連する製品の取得をカスタマイズしたい時に利用され、特定の条件に応じて製品リストを変更することができます。

よく使われるシナリオ

このフィルタは以下のようなシナリオで利用されることが多いです。
1. 特定のタームに関連する製品のみを表示する。
2. タームが関連する製品の表示順序をカスタマイズする。
3. 特定のユーザー権限に基づいて製品をフィルタリングする。
4. 商品カテゴリーに含まれる製品のメタ情報をカスタマイズする。
5. 特定の条件に基づいて製品の表示を制限する。
6. 外部データソースから取得した情報で製品データを補完する。

構文

add_filter( 'woocommerce_taxonomy_objects_$TERM[domain]', 'callback_function', 10, 2 );

パラメータ

$TERM: フィルタリング対象のターム。
domain: 対象となるタクソノミーのドメイン。

戻り値

フィルタリングしたタクソノミーオブジェクトの配列が返されます。

使用可能バージョン

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_objects_product_cat', function($objects, $term) {
    return array_filter($objects, function($product) {
        return $product->get_price() > 50; // 価格が50以上の製品のみ
    });
}, 10, 2);

引用元: https://docs.woocommerce.com

サンプル2: タームの表示順序を変更

このコードは、特定のターム内の製品をアルファベット順に並べ替えるためのサンプルです。

add_filter('woocommerce_taxonomy_objects_product_cat', function($objects, $term) {
    usort($objects, function($a, $b) {
        return strcmp($a->get_name(), $b->get_name());
    });
    return $objects;
}, 10, 2);

引用元: https://www.wpbeginner.com

サンプル3: ユーザー権限によるフィルタリング

このコードは、特定のユーザー権限を持つ場合のみ製品を表示します。

add_filter('woocommerce_taxonomy_objects_product_cat', function($objects, $term) {
    if (!current_user_can('administrator')) {
        return []; // 管理者以外は製品を表示しない
    }
    return $objects;
}, 10, 2);

引用元: https://wordpress.stackexchange.com

サンプル4: メタデータによるカスタマイズ

このコードは、製品のメタ情報に基づいてフィルタリングを行います。

add_filter('woocommerce_taxonomy_objects_product_tag', function($objects, $term) {
    foreach ($objects as $key => $product) {
        if (get_post_meta($product->get_id(), '_featured', true) != 'yes') {
            unset($objects[$key]); // フィーチャーされていない製品を削除
        }
    }
    return $objects;
}, 10, 2);

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

サンプル5: 外部データソースからのデータ補完

このコードは、外部APIから取得した情報で製品リストを補完するための例です。

add_filter('woocommerce_taxonomy_objects_product_cat', function($objects, $term) {
    $external_data = fetch_external_data(); // 外部APIからデータを取得
    foreach ($objects as &$product) {
        if (isset($external_data[$product->get_id()])) {
            $product->custom_field = $external_data[$product->get_id()]['custom_value'];
        }
    }
    return $objects;
}, 10, 2);

引用元: https://sitepoint.com

概要