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

概要

woocommerce_order_update_tax アクションは、WooCommerceにおいて注文の税金情報が更新された際にトリガーされるフックです。このアクションは、税金計算や注文更新のプロセスにおいて多くの開発者に利用されています。具体的には、以下のようなケースでよく使用されます。

税率の変更に応じた追加処理
カスタムサポートチケットの生成
ログの記録
注文更新に応じた通知の送信
他のプラグインとの統合
顧客へのメッセージの表示

構文

do_action( 'woocommerce_order_update_tax', $order );

パラメータ

$order (WC_Order): 税金が更新された注文のオブジェクト。

戻り値

このアクションは特に戻り値を持ちません。

バージョン情報

WooCommerce バージョン: 3.0.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_action( 'woocommerce_order_update_tax', 'send_tax_notification', 10, 1 );
function send_tax_notification( $order ) {
    $to = $order->get_billing_email();
    $subject = '税率が変更されました';
    $message = '注文 #{0} の税率が更新されました。';
    wp_mail( $to, $subject, $message );
}

このコードは、注文の税が更新されたときに顧客のメールアドレスに通知を送信します。

引用元: https://docs.woocommerce.com/

2. 税金の変更をログに記録

このサンプルは、税金が更新された際にその変更をログファイルに記録します。

add_action( 'woocommerce_order_update_tax', 'log_tax_update', 10, 1 );
function log_tax_update( $order ) {
    $log_message = '注文 ' . $order->get_id() . ' の税金が更新されました。';
    error_log( $log_message );
}

このコードは、税金が更新された際にエラーログにメッセージを記録します。

引用元: https://developer.wordpress.org/

3. 税率が変更されたことを管理者に通知

このコードスニペットは、管理者に税率の変更を通知する方法を示しています。

add_action( 'woocommerce_order_update_tax', 'notify_admin_tax_change', 10, 1 );
function notify_admin_tax_change( $order ) {
    $admin_email = get_option( 'admin_email' );
    $subject = '注文の税率が変更されました';
    $message = '注文 ID: ' . $order->get_id() . ' の税率が選択されました。';
    wp_mail( $admin_email, $subject, $message );
}

このサンプルコードは、注文の税が更新されたときに管理者にメールで通知します。

引用元: https://wordpress.org/support/

4. 税金更新時にカスタムフィールドを設定

このサンプルは、税金がアップデートされたときにカスタムフィールドを設定します。

add_action( 'woocommerce_order_update_tax', 'set_custom_field_on_tax_update', 10, 1 );
function set_custom_field_on_tax_update( $order ) {
    $order->update_meta_data( 'tax_updated_at', current_time( 'mysql' ) );
    $order->save();
}

このコードは、税が更新されたときに「税が更新された時間」というカスタムフィールドを追加します。

引用元: https://woocommerce.com/

5. 税金の更新に基づいてクーポンを追加

このサンプルは、税金が更新された場合に自動的にクーポンを追加します。

add_action( 'woocommerce_order_update_tax', 'add_coupon_on_tax_update', 10, 1 );
function add_coupon_on_tax_update( $order ) {
    $order->apply_coupon( 'TAXUPDATE10' );
}

このコードでは、税金が更新されたときに「TAXUPDATE10」というクーポンを自動的に適用します。

引用元: https://www.wpbeginner.com/

概要

構文