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

概要

woocommerce_cart_totals_coupon_html フィルタは、WooCommerce のカートおよびチェックアウトシーンのクーポン合計に関連する HTML の出力を変更するためのものです。このフィルタを使用することで、クーポンの表示形式や文言、デザインを柔軟にカスタマイズすることが可能です。

このフィルタは以下のような機能を実装する際によく使用されます：
1. デフォルトのクーポンメッセージの変更
2. クーポン適用後の合計額のテキストスタイル変更
3. 特定の条件に基づくクーポン表示のカスタマイズ
4. クーポンが無効な場合のエラーメッセージの編集
5. 複数クーポンの積算表示のカスタマイズ
6. クーポン適用後の割引額のプレゼンテーションの変更

構文

add_filter('woocommerce_cart_totals_coupon_html', 'custom_coupon_html', 10, 2);

パラメータ

$coupon_html: クーポンの HTML 表示。
$coupon: クーポンオブジェクト。

戻り値

修正されたクーポンの HTML。

使用可能なバージョン

WooCommerce: すべてのバージョンで使用可能。
WordPress: すべてのバージョンで使用可能。

サンプルコード

サンプルコード 1: クーポンの説明文を変更

add_filter('woocommerce_cart_totals_coupon_html', 'change_coupon_description', 10, 2);
function change_coupon_description($coupon_html, $coupon) {
    return str_replace('割引', '特別割引', $coupon_html);
}

このコードは、カート合計で表示されるクーポンの説明文「割引」を「特別割引」に変更します。

サンプルコード 2: クーポンのテキストカラーを変更

add_filter('woocommerce_cart_totals_coupon_html', 'change_coupon_text_color', 10, 2);
function change_coupon_text_color($coupon_html, $coupon) {
    return '<span style="color: green;">' . $coupon_html . '</span>';
}

このコードは、クーポンのテキストを緑色に変更して表示します。

サンプルコード 3: クーポンが適用されていない場合のメッセージ変更

add_filter('woocommerce_cart_totals_coupon_html', 'custom_coupon_message_if_not_applied', 10, 2);
function custom_coupon_message_if_not_applied($coupon_html, $coupon) {
    if (!$coupon->is_valid()) {
        return '<span style="color: red;">このクーポンは無効です</span>';
    }
    return $coupon_html;
}

このコードは、適用されていないクーポンが無効である場合に、エラーメッセージを表示します。

サンプルコード 4: クーポン名の前にアイコンを追加

add_filter('woocommerce_cart_totals_coupon_html', 'add_icon_to_coupon', 10, 2);
function add_icon_to_coupon($coupon_html, $coupon) {
    return '<img src="path/to/icon.png" alt="クーポンアイコン" /> ' . $coupon_html;
}

このコードは、クーポンの名前の前にアイコンを追加します。

サンプルコード 5: 複数クーポンの合計表示をカスタマイズ

add_filter('woocommerce_cart_totals_coupon_html', 'custom_multiple_coupons_display', 10, 2);
function custom_multiple_coupons_display($coupon_html, $coupon) {
    $coupons = WC()->cart->get_applied_coupons();
    if (count($coupons) > 1) {
        return '合計クーポン (' . count($coupons) . ' 点): ' . $coupon_html;
    }
    return $coupon_html;
}

このコードは、複数のクーポンが適用されている場合に、その情報を表示します。

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

アクション	使用例
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

概要

構文