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

概要

woocommerce_price_inc_tax_amountフィルタは、WooCommerceにおいて税込み価格を表示する際に値を変更するために使用されるフックです。このフィルタを使用することで、税金を含んだ価格に対して様々なカスタマイズを行うことができます。具体的には、以下のような機能を実装する際に頻繁に使用されます。

商品価格にカスタム税率を適用する
特定の条件に基づいて価格の表示形式を変更する
ユーザーのロールによる価格表示の調整
地域ごとに異なる税計算を行う
特定のプロモーションや割引を価格に組み込む
商品やサービスに対する特別な税適用を管理する

woocommerce_price_inc_tax_amountフィルタの基本的な構文は以下の通りです。

add_filter( 'woocommerce_price_inc_tax_amount', 'custom_price_inc_tax', 10, 2 );

パラメータ

$price（float）: 税込み価格の数値
$product（WC_Product）: 価格が関連する商品オブジェクト

戻り値

変更された税込み価格（float）

対応プラグインとバージョン

WooCommerce: すべてのバージョン
WordPress: すべてのバージョン

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

アクション	使用例
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_price_inc_tax_amount', 'change_tax_included_price', 10, 2);

function change_tax_included_price($price, $product) {
    // 10%の税率を追加
    $modified_price = $price * 1.10;
    return $modified_price;
}

このサンプルコードは、商品の税込み価格に10%の税率を追加するカスタマイズを行います。

サンプル2

add_filter('woocommerce_price_inc_tax_amount', 'format_price_with_currency_symbol', 10, 2);

function format_price_with_currency_symbol($price, $product) {
    // カスタムフォーマットで価格を返す
    return '$' . number_format($price, 2);
}

このサンプルは、税込み価格を2桁の小数点付きで通貨記号を付けて表示します。

サンプル3

add_filter('woocommerce_price_inc_tax_amount', 'adjust_price_for_role', 10, 2);

function adjust_price_for_role($price, $product) {
    // 管理者ユーザーには15%の割引を適用
    if (current_user_can('administrator')) {
        $price = $price * 0.85; // 15%引き
    }
    return $price;
}

このコードは、管理者ユーザーに対して税込み価格の15%引きを実施します。

サンプル4

add_filter('woocommerce_price_inc_tax_amount', 'apply_location_based_tax', 10, 2);

function apply_location_based_tax($price, $product) {
    // 地域に基づく税率を適用
    $rate = (WC()->customer->get_billing_country() === 'JP') ? 1.10 : 1.20; // 日本は10%、他は20%
    $price *= $rate;
    return $price;
}

このサンプルでは、顧客の請求国に基づいて異なる税率を適用するロジックを示しています。

サンプル5

add_filter('woocommerce_price_inc_tax_amount', 'include_special_discount', 10, 2);

function include_special_discount($price, $product) {
    // 特定の条件において5%の特別割引を適用
    if (is_product() && $product->get_id() == '123') { // 商品IDが123の場合
        $price *= 0.95;
    }
    return $price;
}

この最後のコードでは、特定の商品に対して5%の特別割引を適用する方法を示しています。

これらのサンプルコードは、著作権フリーのものであり、さまざまなカスタマイズに役立ちます。

概要