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

概要

woocommerce_shipping_calculator_enable_postcode フィルタは、WooCommerceの配送計算において郵便番号フィールドの表示設定を制御するために使用されます。このフックを利用することで、特定の条件に基づいて郵便番号の入力を必須または任意にすることができます。このフィルタは、次のような機能を実装する際によく使われます。

郵便番号入力を非表示にすることで、シンプルなチェックアウトを提供する。
特定の国や地域に対して郵便番号の入力を必須にする。
配送方法の計算の際、郵便番号の有無によるロジックの変更。
ユーザーのロケーションに基づく動的なフィールド表示。
デザインやユーザーインターフェースに基づく条件付き郵便番号フィールド。
顧客満足度向上のためのカスタマイズされたチェックアウト体験の提供。

このフィルタの構文は次の通りです。

apply_filters( 'woocommerce_shipping_calculator_enable_postcode', bool $enabled );

パラメータ

$enabled: boolean – 郵便番号フィールドの表示有無を制御するための真偽値。

戻り値

boolean – 郵便番号フィールドを表示する場合は true、表示しない場合は false。

互換性情報

WooCommerceのバージョン: 2.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_shipping_calculator_enable_postcode', 'custom_disable_postcode_field');

function custom_disable_postcode_field($enabled) {
    if ( is_admin() ) {
        return $enabled; // 管理画面では変更しない
    }
    return false; // チェックアウト時に郵便番号を無効化
}

このサンプルコードは、管理画面以外の場面で郵便番号フィールドを無効にします。

サンプルコード2

add_filter('woocommerce_shipping_calculator_enable_postcode', 'custom_enable_postcode_for_specific_country');

function custom_enable_postcode_for_specific_country($enabled) {
    $country = WC()->customer->get_shipping_country();
    if ($country === 'JP') { // 日本の場合のみ郵便番号を有効にする
        return true;
    }
    return false; // 他の国では無効
}

このコードは、日本の住所の場合のみ郵便番号フィールドを表示します。

サンプルコード3

add_filter('woocommerce_shipping_calculator_enable_postcode', 'custom_enable_postcode_based_on_cart');

function custom_enable_postcode_based_on_cart($enabled) {
    if ( WC()->cart->total > 10000 ) { // カートの合計が10,000円を超えた場合
        return true; // 郵便番号を有効にする
    }
    return false; // その他の場合、郵便番号フィールドを無効
}

このサンプルコードは、カートの合計が一定額を超えたときに郵便番号フィールドを有効にします。

サンプルコード4

add_filter('woocommerce_shipping_calculator_enable_postcode', 'custom_enable_postcode_for_logged_in_users');

function custom_enable_postcode_for_logged_in_users($enabled) {
    if ( is_user_logged_in() ) {
        return true; // ログインユーザーには郵便番号を要求
    }
    return false; // ゲストユーザーには不要
}

このサンプルは、ログインしているユーザーに対してのみ郵便番号入力を要求します。

サンプルコード5

add_filter('woocommerce_shipping_calculator_enable_postcode', 'custom_enable_postcode_based_on_user_role');

function custom_enable_postcode_based_on_user_role($enabled) {
    if ( current_user_can('wholesale_customer') ) {
        return true; // 卸売顧客には郵便番号を必須にする
    }
    return false; // その他のロールには不要
}

このコードは、特定のユーザーロール（卸売顧客）に対してのみ郵便番号の入力を求めます。

これらのサンプルコードは、WooCommerceの配送計算機能をカスタマイズする方法を示しています。それぞれのケースに応じて郵便番号のフィールドを有効または無効にするロジックを実装可能です。

概要