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

概要

woocommerce_new_order_itemアクションは、WooCommerceにおいて新しい注文アイテムが追加されたときに実行されるフックです。このアクションは、注文が作成される際や、カートにアイテムが追加される際に特定の処理を行いたい場合に利用されます。主に以下のような機能を実装する際によく使われます。

1. カスタムメタデータの追加
2. アイテムの在庫管理
3. 注文アイテムに関する通知の送信
4. アイテムに対する特別な割引の適用
5. 外部APIとの連携
6. データ分析やトラッキングのためのロギング

構文

do_action('woocommerce_new_order_item', $item_id, $item, $order_id, $order);

パラメータ

• $item_id (int): 新しく追加された注文アイテムのID。
• $item (object): 追加されたアイテムのオブジェクト。
• $order_id (int): 注文のID。
• $order (object): 注文のオブジェクト。

戻り値

このアクションは特に戻り値を持たず、他の関数を呼び出してそれぞれの処理を行うためのカスタマイズを可能にします。

使用可能なバージョン

• WooCommerce: 3.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_new_order_item', 'add_custom_meta_to_order_item', 10, 4);

function add_custom_meta_to_order_item($item_id, $item, $order_id, $order) {
    $custom_value = 'デフォルト値'; // 追加するカスタムデータ
    wc_add_order_item_meta($item_id, 'custom_meta_key', $custom_value);
}

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

サンプルコード 2: 注文アイテムに対する通知の送信

このコードは、新しい注文アイテムが追加された際に管理者に通知を送信します。

add_action('woocommerce_new_order_item', 'notify_admin_of_new_order_item', 10, 4);

function notify_admin_of_new_order_item($item_id, $item, $order_id, $order) {
    $to = get_option('admin_email');
    $subject = '新しい注文アイテムが追加されました';
    $message = '注文ID: ' . $order_id . ' にアイテムが追加されました。';
    wp_mail($to, $subject, $message);
}

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

サンプルコード 3: 外部APIへのデータ送信

このコードは、新しい注文アイテムが追加された際に外部APIにデータを送信します。

add_action('woocommerce_new_order_item', 'send_data_to_external_api', 10, 4);

function send_data_to_external_api($item_id, $item, $order_id, $order) {
    // APIエンドポイント
    $url = 'https://api.example.com/new-item';
    $data = array(
        'item_id' => $item_id,
        'order_id' => $order_id,
        'item_title' => $item->get_name(),
    );

    wp_remote_post($url, array(
        'method' => 'POST',
        'body' => json_encode($data),
        'headers' => array('Content-Type' => 'application/json'),
    ));
}

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

サンプルコード 4: アイテムの在庫管理

このコードは、新しいアイテムが追加された際に在庫数を減少させる処理を行います。

add_action('woocommerce_new_order_item', 'decrease_stock_on_order_item', 10, 4);

function decrease_stock_on_order_item($item_id, $item, $order_id, $order) {
    $product_id = $item->get_product_id();
    $quantity = $item->get_quantity();

    $product = wc_get_product($product_id);
    if ($product->managing_stock()) {
        $product->set_stock_quantity($product->get_stock_quantity() - $quantity);
        $product->save();
    }
}

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

サンプルコード 5: データ解析のためのロギング

このコードでは、注文アイテムが追加された際にアイテム情報をログに記録します。

add_action('woocommerce_new_order_item', 'log_new_order_item', 10, 4);

function log_new_order_item($item_id, $item, $order_id, $order) {
    $log_message = '新しいアイテムが追加されました: ' . $item->get_name() . ' (ID: ' . $item_id . ')';
    error_log($log_message);
}

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