プラグインWooCommerceのwoocommerce_shipping_zone_method_deletedアクションの使用方法・解説

概要

woocommerce_shipping_zone_method_deleted アクションは、WooCommerce 内で配送方法が削除された際に発火します。このフックは、特定の配送ゾーンから配送メソッドが取り除かれたときに、カスタム処理を実行するために使用されます。例えば、データベースのログ更新やキャッシュのクリアなど、さまざまなタスクを自動化することが可能です。

このアクションが多く使われるシナリオの例としては以下のものがあります：

データベースの整合性チェック
特定の条件に基づく配送設定の調整
ロギングやモニタリングのための情報の記録
その他のカスタム処理のトリガー
ユーザーへの通知を送信
サードパーティサービスとの統合

構文

do_action( 'woocommerce_shipping_zone_method_deleted', $instance_id, $zone_id, $shipping_method );

パラメータ

$instance_id (int): 配送メソッドのインスタンスID。
$zone_id (int): 削除された配送料金ゾーンのID。
$shipping_method (WC_Shipping_Method): 削除された配送メソッドのオブジェクト。

戻り値

このアクションは特に戻り値はなく、フックに付随して実行されるカスタム関数の処理を実行します。

バージョン情報

使用可能なWooCommerceのバージョン: 3.0.0以上
使用可能なWordPressのバージョン: 4.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_action( 'woocommerce_shipping_zone_method_deleted', 'my_shipping_method_deleted_action', 10, 3 );

function my_shipping_method_deleted_action( $instance_id, $zone_id, $shipping_method ) {
    // 配送メソッド削除のログを記録する
    error_log( '配送メソッドが削除されました: ' . $shipping_method->title );
}

このコードは、配送メソッドが削除されたときに、その情報をエラーログに記録します。

サンプルコード 2

add_action( 'woocommerce_shipping_zone_method_deleted', 'notify_admin_shipping_method_deleted', 10, 3 );

function notify_admin_shipping_method_deleted( $instance_id, $zone_id, $shipping_method ) {
    // 管理者に通知メールを送信
    wp_mail( get_option( 'admin_email' ), '配送メソッド削除されました', '配送メソッド ' . $shipping_method->title . ' が削除されました。' );
}

このコードは、配送メソッドが削除された際に、管理者にメール通知を送信します。

サンプルコード 3

add_action( 'woocommerce_shipping_zone_method_deleted', 'clear_shipping_cache', 10, 3 );

function clear_shipping_cache( $instance_id, $zone_id, $shipping_method ) {
    // 配送のキャッシュをクリアする処理
    delete_transient( 'shipping_zone_' . $zone_id );
}

このコードは、配送ゾーンから配送メソッドが削除された際に、そのゾーンのキャッシュをクリアします。

サンプルコード 4

add_action( 'woocommerce_shipping_zone_method_deleted', 'update_shipping_options', 10, 3 );

function update_shipping_options( $instance_id, $zone_id, $shipping_method ) {
    // 配送オプションを再計算する処理
    if ( class_exists('WC_Shipping_Zones') ) {
        WC_Shipping_Zones::instance()->get_zone( $zone_id )->calculate_shipping();
    }
}

このコードは、配送メソッドが削除された後に配送オプションを再計算します。

サンプルコード 5

add_action( 'woocommerce_shipping_zone_method_deleted', 'remove_custom_data_on_shipping_method_delete', 10, 3 );

function remove_custom_data_on_shipping_method_delete( $instance_id, $zone_id, $shipping_method ) {
    global $wpdb;
    // カスタムデータを削除する処理
    $wpdb->delete( 'wp_custom_shipping_data', array( 'instance_id' => $instance_id ) );
}

このコードは、削除された配送メソッドに関連するカスタムデータをデータベースから削除します。

概要

構文