プラグインWooCommerceのwoocommerce_pre_delete_$THIS->OBJECT_TYPEアクションの使用方法・解説

概要

woocommerce_pre_delete_$THIS->OBJECT_TYPE は、WooCommerceでオブジェクトを削除する前にトリガーされるアクションフックです。このアクションは、特定のオブジェクトタイプ（たとえば、製品や注文など）が削除される前にカスタム処理を追加するためによく使用されます。このフックを使用することで、削除プロセスの前に特定の条件を検証したり、ログを記録したり、他のクリーンアップ作業を実行したりすることができます。

よく使われる機能

削除されるオブジェクトのバックアップを作成する
削除操作にカスタムバリデーションを追加する
削除後のリダイレクトを設定する
削除操作に関連するメタデータを削除する
ログ管理システムと統合する
削除依頼を通知するシステムを実装する

構文

do_action('woocommerce_pre_delete_$THIS->OBJECT_TYPE', $object_id);

パラメータ

$object_id (int): 削除対象のオブジェクトのID。

戻り値

なし

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

WooCommerce: すべてのバージョン
WordPress: WooCommerceに依存する最低バージョン

サンプルコード

サンプル1: 削除前のバックアップ作成

add_action('woocommerce_pre_delete_product', 'backup_product_before_delete', 10, 1);
function backup_product_before_delete($product_id) {
    $product = wc_get_product($product_id);
    $backup = array(
        'id' => $product->get_id(),
        'name' => $product->get_name(),
        'price' => $product->get_price(),
    );
    // バックアップをデータベースに保存する処理
}

このサンプルコードでは、製品が削除される前に、その製品の情報をバックアップする処理を行っています。

サンプル2: 削除操作のキャンセル

add_action('woocommerce_pre_delete_order', 'cancel_order_delete', 10, 1);
function cancel_order_delete($order_id) {
    if (!current_user_can('delete_orders')) {
        wp_die('You do not have sufficient permissions to delete this order.');
    }
}

このサンプルは、ユーザーが特定の権限を持っていない場合、注文の削除をキャンセルします。

サンプル3: 削除前に通知を送信

add_action('woocommerce_pre_delete_coupon', 'notify_admin_before_coupon_delete', 10, 1);
function notify_admin_before_coupon_delete($coupon_id) {
    wp_mail('admin@example.com', 'Coupon Deleted', 'Coupon with ID ' . $coupon_id . ' is about to be deleted.');
}

このサンプルコードは、クーポンが削除される前に管理者に通知メールを送信します。

サンプル4: 特定の条件で削除を防止

add_action('woocommerce_pre_delete_product', 'prevent_product_delete_if_sold', 10, 1);
function prevent_product_delete_if_sold($product_id) {
    $product = wc_get_product($product_id);
    if ($product->get_stock_quantity() > 0) {
        wp_die('You cannot delete a product that is still in stock.');
    }
}

このコードでは、在庫がある製品の削除を防止しています。

サンプル5: 削除記録をログに残す

add_action('woocommerce_pre_delete_category', 'log_category_deletion', 10, 1);
function log_category_deletion($category_id) {
    error_log('Category with ID ' . $category_id . ' is being deleted.');
}

このサンプルは、カテゴリが削除される時にその情報をエラーログに記録します。

この関数のアクションでの使用可能性

アクション名	使用可能性
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

この表は、woocommerce_pre_delete_$THIS->OBJECT_TYPEアクションの使用可能性を示しています。各アクションがこのフックで使用されるかどうかを確認することで、適切なタイミングでのフック利用を把握できます。

概要