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

概要

woocommerce_product_object_query フィルタは、WooCommerce の製品クエリに対してカスタマイズを行うためのフックです。具体的には、製品に関するデータを取得する際の SQL クエリに影響を与えることができます。このフィルタは、特定の条件に基づいて製品をフィルタリングしたり、表示する製品の属性を変更する際に非常に便利です。

よく使用されるケースとしては、以下のようなシナリオがあります：

特定のカテゴリーの製品のみを表示する。
在庫状況に基づいて表示する製品を制限する。
製品のカスタムメタフィールドをもとにフィルタリングを行う。
製品の価格レンジによるフィルタリング。
製品の公開ステータスに応じた表示の制御。
製品のスラッグやタイトルによる特定の製品の選択。

構文

add_filter('woocommerce_product_object_query', 'your_function_name', 10, 2);

パラメータ

$query – WP_Query オブジェクト。製品クエリの設定を持っています。
$query_vars – クエリの変数。フィルタリングの条件に基づく変更を行うことができます。

戻り値

woocommerce_product_object_query フィルタは、変更された WP_Query オブジェクトを戻り値として返します。

WooCommerce と WordPress のバージョン

WooCommerce のバージョン: 5.0 以降
WordPress のバージョン: 5.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_product_object_query', 'filter_products_by_category', 10, 2);

function filter_products_by_category($query, $query_vars) {
    $query->set('tax_query', array(
        array(
            'taxonomy' => 'product_cat',
            'field'    => 'slug',
            'terms'    => '特定のカテゴリー', // カテゴリー名を指定
        ),
    ));
    return $query;
}

サンプル 2: 在庫のある製品のみを表示する

このコードは、在庫がある製品のみを表示します。

add_filter('woocommerce_product_object_query', 'filter_in_stock_products', 10, 2);

function filter_in_stock_products($query, $query_vars) {
    $query->set('meta_query', array(
        array(
            'key'     => '_stock_status',
            'value'   => 'instock',
            'compare' => '=',
        ),
    ));
    return $query;
}

サンプル 3: カスタムメタに基づいてフィルタリング

このコードは、カスタムメタフィールドに基づいて製品をフィルタリングします。

add_filter('woocommerce_product_object_query', 'filter_products_by_custom_meta', 10, 2);

function filter_products_by_custom_meta($query, $query_vars) {
    $query->set('meta_query', array(
        array(
            'key'     => 'custom_meta_key', // メタキーを指定
            'value'   => 'custom_value',     // メタ値を指定
            'compare' => '=',
        ),
    ));
    return $query;
}

サンプル 4: 価格レンジによるフィルタリング

このコードでは、製品の価格が特定のレンジにあるものを表示します。

add_filter('woocommerce_product_object_query', 'filter_products_by_price', 10, 2);

function filter_products_by_price($query, $query_vars) {
    $min_price = 50; // 最小価格
    $max_price = 150; // 最大価格
    $query->set('meta_query', array(
        array(
            'key'     => '_price',
            'value'   => array($min_price, $max_price),
            'compare' => 'BETWEEN',
            'type'    => 'DECIMAL',
        ),
    ));
    return $query;
}

サンプル 5: 公開ステータスに基づく制御

このコードは、公開されている製品のみを表示します。

add_filter('woocommerce_product_object_query', 'filter_published_products', 10, 2);

function filter_published_products($query, $query_vars) {
    $query->set('post_status', 'publish');
    return $query;
}

これらのサンプルコードは、WooCommerce の製品クエリをさまざまな方法でカスタマイズするのに役立ちます。各コードは具体的な条件に基づいた製品の表示を制御することができます。

概要

構文