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

概要

woocommerce_update_order は、WooCommerce の注文情報が更新された際にトリガーされるアクションフックです。このフックは、特定の注文が変更された後に追加の処理を行いたい場合に非常に役立ちます。例えば、支払いステータスの変更、在庫の調整、注文の通知メール送信など、さまざまな用途で利用されます。具体的には以下のような機能を実装する場合によく使われます。

注文ステータス変更時の通知の送信
外部システムとのデータ連携
注文のメタデータを更新する
支払い情報の更新
ユーザーへのカスタムメッセージの表示
分析用のトラッキングデータの収集

構文

add_action('woocommerce_update_order', 'your_function_name', 10, 1);

パラメータ

order_id: 更新された注文の ID（整数型）

戻り値

このアクションフック自体には戻り値はありません。

使用可能なプラグインバージョン

WooCommerce: 2.0.0 以降
WordPress: 3.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_update_order', 'send_custom_order_notification', 10, 1);

function send_custom_order_notification($order_id) {
    $order = wc_get_order($order_id);
    wp_mail('admin@example.com', 'Order Updated', 'Order ID ' . $order_id . ' has been updated.');
}

このサンプルコードは、注文が更新された際に管理者にメール通知を送信します。wc_get_order 関数を使用して注文オブジェクトを取得し、更新を知らせるメールを送ります。

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

サンプルコード2

add_action('woocommerce_update_order', 'update_inventory_on_order_change', 10, 1);

function update_inventory_on_order_change($order_id) {
    $order = wc_get_order($order_id);
    foreach ($order->get_items() as $item) {
        $product = $item->get_product();
        $product->reduce_stock_quantity($item->get_quantity());
    }
}

このコードは、更新された注文の商品の在庫を自動的に減少させます。各アイテムに対して在庫数を調整します。

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

サンプルコード3

add_action('woocommerce_update_order', 'log_order_updates', 10, 1);

function log_order_updates($order_id) {
    error_log('Order ID ' . $order_id . ' was updated on ' . date('Y-m-d H:i:s'));
}

このコードは、注文の更新をログファイルに記録します。error_log 関数を使用して、更新された日時と共に注文IDを記録します。

(引用元: https://codex.wordpress.org)

サンプルコード4

add_action('woocommerce_update_order', 'custom_update_order_meta', 10, 1);

function custom_update_order_meta($order_id) {
    update_post_meta($order_id, '_custom_meta_key', 'Updated Value');
}

このサンプルでは、更新された注文にカスタムメタデータを追加しています。update_post_meta 関数を使用して新しい値を設定します。

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

サンプルコード5

add_action('woocommerce_update_order', 'redirect_after_order_update', 10, 1);

function redirect_after_order_update($order_id) {
    $url = 'https://example.com/order-updated';
    wp_redirect($url);
    exit;
}

このコードは、注文が更新された後に特定のURLへリダイレクトします。wp_redirect 関数を使用してリダイレクト処理を行います。

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

概要

構文