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

概要

woocommerce_shortcode_products_query_resultsフィルタは、WooCommerceのショートコード（特に商品表示に関わるショートコード）によって生成されるクエリ結果をカスタマイズするために使用されます。このフィルタを使うことで、開発者は特定の商品を絞り込んだり、表示数を変更したり、並び替えを行うことができます。具体的には以下のような機能を実装する際に役立ちます。

特定のカテゴリの商品を表示する
特定のメタデータに基づいて商品をフィルタリングする
商品の表示順序をカスタマイズする
表示する商品の数を動的に変更する
ユーザーに基づいたカスタマイズ（例えば、特定のユーザーにのみ表示する商品）
商品のカスタムクエリを作成する

構文

add_filter( 'woocommerce_shortcode_products_query_results', 'カスタム関数名', 10, 2 );

パラメータ

$query : WP_Queryオブジェクト。ショートコードによって生成された商品クエリが含まれる。
$atts : ショートコードの属性（配列）。ユーザーが指定したショートコードの条件が含まれる。

戻り値

修正されたWP_Queryオブジェクト。

使用可能なWooCommerceのバージョン

WooCommerce 2.6以上

使用可能なWordPressのバージョン

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_shortcode_products_query_results', 'filter_products_by_category', 10, 2 );

function filter_products_by_category( $query, $atts ) {
    $query->set( 'tax_query', array(
        array(
            'taxonomy' => 'product_cat',
            'field'    => 'slug',
            'terms'    => '特定のカテゴリーのスラッグ',
        ),
    ));
    return $query;
}

サンプル2: 商品の表示数を動的に変更する

このサンプルは、ショートコードを使うときに、表示する商品の数を動的に変更します。

add_filter( 'woocommerce_shortcode_products_query_results', 'change_product_limit', 10, 2 );

function change_product_limit( $query, $atts ) {
    $query->set( 'posts_per_page', 5 ); // 表示する商品の数を5に設定
    return $query;
}

サンプル3: 商品の並び替えをカスタマイズする

このサンプルは、商品の表示順序をカスタマイズします。

add_filter( 'woocommerce_shortcode_products_query_results', 'customize_product_sort_by', 10, 2 );

function customize_product_sort_by( $query, $atts ) {
    $query->set( 'orderby', 'date' ); // 日付順に並び替え
    $query->set( 'order', 'DESC' );    // 降順
    return $query;
}

サンプル4: ユーザーの購入履歴に基づいて商品をフィルタリングする

このサンプルは、特定のユーザーが過去に購入した商品を表示します。

add_filter( 'woocommerce_shortcode_products_query_results', 'filter_products_by_purchased', 10, 2 );

function filter_products_by_purchased( $query, $atts ) {
    $user_id = get_current_user_id();
    $orders = wc_get_orders( array( 'customer_id' => $user_id ) );
    $product_ids = array();

    foreach ( $orders as $order ) {
        $items = $order->get_items();
        foreach ( $items as $item ) {
            $product_ids[] = $item->get_product_id();
        }
    }

    $query->set( 'post__in', $product_ids );
    return $query;
}

サンプル5: 商品メタデータに基づくフィルタリング

このサンプルは、商品メタデータに基づいて商品の表示を制御します。

add_filter( 'woocommerce_shortcode_products_query_results', 'filter_products_by_meta_data', 10, 2 );

function filter_products_by_meta_data( $query, $atts ) {
    $meta_query = $query->get( 'meta_query' );
    $meta_query[] = array(
        'key'     => '_custom_meta_key',
        'value'   => '特定の値',
        'compare' => '=', // メタデータが「特定の値」と一致する商品をフィルタリング
    );

    $query->set( 'meta_query', $meta_query );
    return $query;
}

引用元のページ:
– https://developer.woocommerce.com/document/hooks/
– https://docs.woocommerce.com/wc-apidocs/class-WC_Shortcode_Products.html

概要

構文