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

概要

woocommerce_order_hide_zero_taxes フィルタは、WooCommerceの注文の表示に関連するフックで、ゼロ税金の明細を非表示にする際に使用されます。このフィルタを使うことで、カスタムビジネスロジックに基づいて、税金がゼロの項目を注文リストから除外することができます。よく使われる機能の例には以下があります。

ゼロ税率の商品を自動的に表示しない
クライアント向けの領収書から不要な税情報を隠す
管理画面での注文リストをクリーンに保つ
特定の顧客グループにカスタマイズされた領収書を提供
プロモーションアイテムの税務処理を簡素化
商品別のレポートの精度を向上させる

構文

add_filter('woocommerce_order_hide_zero_taxes', 'your_custom_function');

パラメータ

$hide_zero_taxes (bool): ゼロ税金を非表示にするかどうかを示すブール値。
$order (WC_Order): 現在の注文オブジェクト。

戻り値

bool: ゼロ税金を非表示にする場合は true、そうでない場合は false。

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

WooCommerce: 3.0以上
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_order_hide_zero_taxes', function($hide_zero_taxes, $order) {
    // 注文が特定のステータスの場合には、ゼロ税金を表示
    if ($order->get_status() === 'completed') {
        return false;
    }
    return $hide_zero_taxes;
});

このコードは、注文が「完了」となった場合にはゼロ税金を表示するように設定します。

サンプルコード 2

add_filter('woocommerce_order_hide_zero_taxes', '__return_true');

この短いコードは、すべてのゼロ税金を常に非表示にします。

サンプルコード 3

add_filter('woocommerce_order_hide_zero_taxes', function($hide_zero_taxes, $order) {
    // 顧客がVIPの場合、ゼロ税金を表示
    if ($order->get_meta('customer_type') === 'VIP') {
        return false;
    }
    return $hide_zero_taxes;
});

このコードでは、「VIP」顧客の注文に対してゼロ税金を表示します。

サンプルコード 4

add_filter('woocommerce_order_hide_zero_taxes', function($hide_zero_taxes) {
    // 特定のユーザーIDの場合はゼロ税金を表示
    if (get_current_user_id() === 1) {
        return false;
    }
    return $hide_zero_taxes;
});

このコードは特定のユーザー（ID 1）の注文に対してゼロ税金を表示します。

サンプルコード 5

add_filter('woocommerce_order_hide_zero_taxes', function($hide_zero_taxes) {
    // 環境設定に応じてゼロ税金を表示
    if (get_option('show_zero_taxes') === 'yes') {
        return false;
    }
    return $hide_zero_taxes;
});

このコードは、設定オプションに基づいてゼロ税金の表示を制御します。

概要

構文