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

概要

woocommerce_countries_base_cityフィルタは、WooCommerceの地理的情報やデリバリーの設定をカスタマイズする際に使用されます。このフィルタを使用することで、国ごとの基準都市を変更したり、特定の条件下で異なる都市を返すことができます。主に次のような機能を実装する際によく使われます。

特定の国の基準都市をカスタマイズする。
ユーザーが選択した国に基づいてデフォルトの都市を動的に変更する。
地域ごとの配送エリア設定を調整する。
フォームのプレースホルダやデフォルト値を変更する。
特定の条件に基づいてエラーメッセージをカスタマイズする。
独自の配送オプションを実装する。

フィルタの概要

構文: add_filter( 'woocommerce_countries_base_city', 'your_function_name' );
パラメータ: string $city – 変更対象の基準都市。
戻り値: string – カスタマイズ後の都市名。
使用可能なプラグイン: WooCommerce
WooCommerceのバージョン: 5.0.0以上
WordPressのバージョン: 5.0.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_countries_base_city', 'change_base_city' );

function change_base_city( $city ) {
    if ( isset( $_POST['billing_country'] ) && $_POST['billing_country'] === 'JP' ) {
        return '東京';
    }
    return $city;
}

このコードは、日本の住所が選択された場合に基準都市を「東京」に変更します。

サンプルコード2: 異なる条件での都市設定

add_filter( 'woocommerce_countries_base_city', 'dynamic_base_city' );

function dynamic_base_city( $city ) {
    $user_location = get_user_location(); // カスタム関数でユーザーの位置情報を取得
    if ( $user_location === 'Osaka' ) {
        return '大阪';
    }
    return $city;
}

このコードは、取得したユーザーの位置情報によって基準都市を「大阪」に動的に変更します。

サンプルコード3: 都市名のプレースホルダ変更

add_filter( 'woocommerce_countries_base_city', 'change_city_placeholder' );

function change_city_placeholder( $city ) {
    return 'デフォルトの都市名';
}

このコードは、基準都市のプレースホルダを「デフォルトの都市名」に変更します。

サンプルコード4: カスタムエラーメッセージの設定

add_filter( 'woocommerce_countries_base_city', 'custom_error_message' );

function custom_error_message( $city ) {
    if ( empty( $city ) ) {
        wc_add_notice( '都市名が必要です', 'error' );
    }
    return $city;
}

このコードは、基準都市が空のときにカスタムエラーメッセージを表示します。

サンプルコード5: 特定の配送ゾーンに基づく都市

add_filter( 'woocommerce_countries_base_city', 'custom_shipping_zone_city' );

function custom_shipping_zone_city( $city ) {
    $shipping_zone = WC_Shipping_Zones::get_zone_by( 'id', 1 ); // IDが1の配送ゾーン
    if ( $shipping_zone ) {
        return '配送エリア1の都市';
    }
    return $city;
}

このコードは、特定の配送ゾーンに基づいて基準都市を「配送エリア1の都市」に変更します。

概要