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

概要

woocommerce_calculated_total フィルタは、WooCommerceにおいてカートやチェックアウト時の合計金額を計算する際に、カスタマイズされた金額を提供するために使用されます。このフィルタを使用することで、開発者は合計金額に対して追加の条件や計算を適用することが可能になります。具体的には、以下のような機能を実装する際に役立ちます。

特定の条件に基づく割引の適用
手数料や追加料金の追加
特定の製品カテゴリに基づく価格調整
クーポンやプロモーションの影響を反映
地域や顧客のロイヤルティに応じた価格設定
顧客の購入履歴に基づくカスタマイズされた価格

構文

add_filter('woocommerce_calculated_total', 'custom_calculated_total', 10, 2);

パラメータ

$calculated_total (float): 計算された合計金額
$cart (WC_Cart): 現在のカートオブジェクト

戻り値

(float): 修正された合計金額

利用可能なバージョン

WooCommerce バージョン: 3.0以上
WordPress バージョン: 4.0以上

サンプルコード

サンプルコード 1: 特定商品への割引適用

add_filter('woocommerce_calculated_total', 'apply_discount_to_specific_product', 10, 2);

function apply_discount_to_specific_product($calculated_total, $cart) {
    foreach ($cart->get_cart() as $cart_item) {
        if ($cart_item['product_id'] == 123) { // 商品IDが123の場合
            $calculated_total -= 5; // 5ドルの割引
        }
    }
    return $calculated_total;
}

このコードは、特定の商品のID（ここでは123）に対して5ドルの割引を適用します。特定の商品購入時に割引を提供する用途に便利です。
引用元: https://woocommerce.com/

サンプルコード 2: 購入金額に応じた手数料の追加

add_filter('woocommerce_calculated_total', 'add_fee_based_on_total', 10, 2);

function add_fee_based_on_total($calculated_total, $cart) {
    if ($calculated_total > 100) {
        $calculated_total += 10; // 100ドル以上の合計に10ドルの手数料を追加
    }
    return $calculated_total;
}

このコードは、購入金額が100ドルを超えた場合、10ドルの手数料を追加します。特定の価格帯に応じた手数料を設定したい場合に使えます。
引用元: https://woocommerce.com/

サンプルコード 3: 地域による価格調整

add_filter('woocommerce_calculated_total', 'adjust_price_based_on_region', 10, 2);

function adjust_price_based_on_region($calculated_total, $cart) {
    $customer_country = WC()->customer->get_billing_country();
    if ($customer_country == 'JP') { // 日本の場合
        $calculated_total *= 1.1; // 10%の価格上乗せ
    }
    return $calculated_total;
}

このコードは、日本の顧客に対して10%の価格上乗せを行います。地域による価格戦略を実施する際に役立ちます。
引用元: https://woocommerce.com/

サンプルコード 4: 優遇顧客への特別割引

add_filter('woocommerce_calculated_total', 'apply_discount_for_loyal_customers', 10, 2);

function apply_discount_for_loyal_customers($calculated_total, $cart) {
    if (user_has_loyalty_status()) { // 顧客が優遇ステータスを持つ場合
        $calculated_total -= 10; // 10ドルの割引
    }
    return $calculated_total;
}

function user_has_loyalty_status() {
    // ここで顧客のロイヤルティステータスをチェック
    return true; // 簡略化のため常にtrueを返す
}

このコードは、特定のロイヤルティステータスを持つ顧客に対して10ドルの割引を適用します。他のロイヤルティプログラムと連携する場合に使えます。
引用元: https://woocommerce.com/

サンプルコード 5: クーポンの効果を考慮した合計金額の調整

add_filter('woocommerce_calculated_total', 'adjust_total_based_on_coupon', 10, 2);

function adjust_total_based_on_coupon($calculated_total, $cart) {
    if ($cart->has_discount()) { // クーポンが適用されている場合
        $calculated_total -= 15; // 15ドルの追加割引
    }
    return $calculated_total;
}

このコードは、クーポンが適用されている場合にさらに15ドルの割引を提供します。複数のプロモーションを組み合わせる際に便利です。
引用元: https://woocommerce.com/

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

アクション	使用可能性
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

この表は、woocommerce_calculated_total フィルタがどのアクションで使用できるかを示しています。具体的なアクションにおける使用例はありませんが、WooCommerceの機能を拡張する際に非常に便利です。

概要

構文