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

概要

woocommerce_upsells_order フィルタは、WooCommerce プラグインにおいて、アップセル商品を表示する順序を変更するために使用されます。このフィルタは、アップセル商品がカートに追加された際に、表示される商品をカスタマイズする際によく利用されます。以下のような機能を実装する際によく使われます。

アップセル商品の表示順序をカスタマイズ
特定の条件に基づいてアップセル商品をフィルタリング
商品の価格や在庫状況に応じたアップセル商品のソート
ユーザーの過去の購入履歴に基づくアップセル商品の並び替え
人気のある商品を優先して表示
カスタマイズしたクエリを用いて新しい商品のリストを作成

構文

add_filter( 'woocommerce_upsells_order', 'custom_upsells_order_function' );

パラメータ

$upsells (array): 現在のアップセル商品リスト。
$product (WC_Product): 現在の製品オブジェクト。

戻り値

array: アップセル商品の新しい順序を返します。

使用可能なバージョン

WooCommerce: 2.1 以降
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_upsells_order', 'reverse_upsell_order' );

function reverse_upsell_order( $upsells ) {
    return array_reverse( $upsells );
}

このサンプルコードは、アップセル商品の表示順序を逆にするものです。

サンプルコード2: 特定のカテゴリーのアップセル商品を優先表示

add_filter( 'woocommerce_upsells_order', 'custom_priority_upsells' );

function custom_priority_upsells( $upsells ) {
    $cat_priority = array();
    foreach ( $upsells as $product_id ) {
        $terms = get_the_terms( $product_id, 'product_cat' );
        foreach ( $terms as $term ) {
            if ( $term->slug === 'preferred-category' ) {
                $cat_priority[] = $product_id;
                break;
            }
        }
    }
    return array_merge( $cat_priority, array_diff( $upsells, $cat_priority ) );
}

このコードは、特定のカテゴリー（preferred-category）のアップセル商品を優先的に表示するものです。

サンプルコード3: アップセル商品の価格でソート

add_filter( 'woocommerce_upsells_order', 'sort_upsells_by_price' );

function sort_upsells_by_price( $upsells ) {
    usort( $upsells, function( $a, $b ) {
        return wc_get_price_to_display( wc_get_product( $a ) ) <=> wc_get_price_to_display( wc_get_product( $b ) );
    });
    return $upsells;
}

このサンプルは、アップセル商品を価格でソートするためのものです。

サンプルコード4: ユーザーの購入履歴に基づくアップセル商品表示

add_filter( 'woocommerce_upsells_order', 'custom_upsells_by_purchase_history' );

function custom_upsells_by_purchase_history( $upsells ) {
    $customer_orders = wc_get_orders( array(
        'customer_id' => get_current_user_id(),
    ) );

    // 購入履歴に基づくロジックを追加（簡略化のため省略）

    return $upsells; // 修正された商品順序を返す
}

このコードは、ユーザーの過去の購入履歴に基づいてアップセル商品を表示するためのスタート地点となるコードです。

サンプルコード5: 在庫のあるアップセル商品だけを表示

add_filter( 'woocommerce_upsells_order', 'only_in_stock_upsells' );

function only_in_stock_upsells( $upsells ) {
    return array_filter( $upsells, function( $product_id ) {
        $product = wc_get_product( $product_id );
        return $product && $product->is_in_stock();
    });
}

このサンプルでは、在庫があるアップセル商品だけを表示するフィルタを実装しています。

概要

構文