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

概要

woocommerce_coupon_discount_amount_html フィルタは、WooCommerceにおけるクーポンの割引金額のHTML表現を変更するために使用されます。このフィルタは、割引金額の表示形式や内容をカスタマイズしたい場合に非常に便利です。一般的な使用例としては以下のものがあります。

割引金額の前後に追加のテキストを挿入する
特定の条件に基づいて割引表示のフォーマットを変更する
通常の割引と比べて特別な割引の表示方法を別に設定する
割引金額の単位（例えば通貨記号など）を変更する
割引をパーセンテージで表示するスタイルを変更する
割引の視覚的な強調やスタイルを変更する

構文

add_filter('woocommerce_coupon_discount_amount_html', 'custom_discount_amount_html', 10, 2);

パラメータ

string $discount_amount – 割引金額のHTML
WC_Discount $coupon – クーポンオブジェクト

戻り値

カスタマイズされた割引金額のHTML文字列。

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

WooCommerce 2.0 以降で利用可能。

使用可能な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_coupon_discount_amount_html', 'add_text_before_discount', 10, 2);
function add_text_before_discount($discount_html, $coupon) {
    return '<strong>割引額:</strong> ' . $discount_html;
}

このコードは、割引金額の前に「割引額:」というテキストを追加しています。

サンプルコード2: 割引金額をパーセンテージ表示に変更

add_filter('woocommerce_coupon_discount_amount_html', 'change_discount_to_percentage', 10, 2);
function change_discount_to_percentage($discount_html, $coupon) {
    $discount_amount = $coupon->get_discount_amount();
    return '<span>' . $discount_amount . '% OFF</span>';
}

このコードは、割引金額をパーセンテージ表示に変更しています。

サンプルコード3: 割引金額を赤色で強調表示

add_filter('woocommerce_coupon_discount_amount_html', 'highlight_discount_amount', 10, 2);
function highlight_discount_amount($discount_html, $coupon) {
    return '<span style="color:red;">' . $discount_html . '</span>';
}

このコードは、割引金額を赤色で強調表示しています。

サンプルコード4: 通貨記号を表示に追加

add_filter('woocommerce_coupon_discount_amount_html', 'add_currency_symbol', 10, 2);
function add_currency_symbol($discount_html, $coupon) {
    return '¥' . $discount_html;
}

このコードは、割引金額の前に日本円の通貨記号を追加しています。

サンプルコード5: 割引を特別なフォーマットで表示

add_filter('woocommerce_coupon_discount_amount_html', 'special_format_for_discount', 10, 2);
function special_format_for_discount($discount_html, $coupon) {
    return '<span style="font-weight:bold; font-size:1.2em;">' . $discount_html . ' 割引!</span>';
}

このコードは、割引金額をボOLDで強調表示し、フォントサイズを大きくして特別な印象を与えています。

概要

構文