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

概要

woocommerce_before_delete_order_itemは、WooCommerceで注文アイテムを削除する前にトリガーされるアクションフックです。このフックは、注文に関連するアイテムが削除される直前にカスタム処理を追加したい場合に役立ちます。具体的には、以下のような機能を実装する際によく使用されます：

削除されるアイテムに基づいて特定のアクションを実行する。
削除操作をキャンセルするためのバリデーションを実施する。
削除されるアイテムに関連するメタデータのクリーニングを行う。
削除前のアイテムに対して通知を送信する。
カスタムロギング機能を追加して、削除されたアイテムのトラッキングを行う。
削除処理の結果を他のシステム（例：CRM）に反映させる。

構文

add_action( 'woocommerce_before_delete_order_item', 'custom_function_name', 10, 2 );

パラメータ

$item_id (int): 削除される商品のID。
$order_id (int): 削除される商品が属する注文のID。

戻り値

特になし。このアクション自体は、何も値を返しません。

使用可能なバージョン

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_before_delete_order_item', 'log_deleted_order_item', 10, 2 );

function log_deleted_order_item( $item_id, $order_id ) {
    $item_name = wc_get_order_item_meta( $item_id, '_product_id', true );
    error_log( "Order Item ID " . $item_id . " from Order ID " . $order_id . " is being deleted." );
}

このコードは、削除される注文アイテムのIDとその注文IDをエラーログに記録します。

サンプルコード2: 削除のキャンセル

add_action( 'woocommerce_before_delete_order_item', 'prevent_order_item_deletion', 10, 2 );

function prevent_order_item_deletion( $item_id, $order_id ) {
    // 条件が満たされている場合、削除をキャンセル
    if ( some_custom_condition() ) {
        wp_die( 'このアイテムは削除できません。' );
    }
}

このコードは、特定の条件を満たす場合、削除処理をキャンセルし、エラーメッセージを表示します。

サンプルコード3: メタデータのクリーニング

add_action( 'woocommerce_before_delete_order_item', 'clean_order_item_meta', 10, 2 );

function clean_order_item_meta( $item_id, $order_id ) {
    delete_post_meta( $item_id, '_some_meta_key' );
}

このコードは、削除される注文アイテムに関連する特定のメタデータを削除します。

サンプルコード4: 削除通知の送信

add_action( 'woocommerce_before_delete_order_item', 'send_deletion_notification', 10, 2 );

function send_deletion_notification( $item_id, $order_id ) {
    $to = 'admin@example.com';
    $subject = 'アイテム削除通知';
    $message = "Order Item ID " . $item_id . " from Order ID " . $order_id . " has been deleted.";
    wp_mail( $to, $subject, $message );
}

このコードは、削除されるアイテムについて通知メールを送信します。

サンプルコード5: 削除済みアイテムの情報をデータベースに保存

add_action( 'woocommerce_before_delete_order_item', 'save_deleted_item_info', 10, 2 );

function save_deleted_item_info( $item_id, $order_id ) {
    global $wpdb;
    $wpdb->insert(
        'deleted_order_items',
        array(
            'item_id' => $item_id,
            'order_id' => $order_id,
            'deleted_at' => current_time( 'mysql' ),
        )
    );
}

このコードは、削除された注文アイテムの情報をカスタムデータベーステーブルに保存します。

概要

構文