プラグインWooCommerceのwoocommerce_cancel_unpaid_orders_interval_minutesフィルタの使用方法・解説

概要

woocommerce_cancel_unpaid_orders_interval_minutes は WooCommerce プラグインで使用されるフィルターフックで、未払い注文をキャンセルするための間隔（分数）を設定するために使用されます。このフィルタは、オンラインストアの管理者が未払いの注文に対して自動的に何分後にキャンセルするかを調整することを可能にし、顧客やストアの運営において重要な役割を果たします。このフィルタは、特に以下のような機能を実装する際に役立ちます。

未払い注文のキャンセルプロセスをカスタマイズ
注文処理の効率を向上
ストアの在庫管理を自動化
顧客への通知を適切にタイミングする
財務管理の精度を向上
ストアポリシーに基づく柔軟な設定

構文

add_filter('woocommerce_cancel_unpaid_orders_interval_minutes', 'custom_cancel_unpaid_orders_interval');

function custom_cancel_unpaid_orders_interval($minutes) {
    return $minutes; // 必要に応じて新しい間隔を返す
}

パラメータ

$minutes: 現在の未払い注文キャンセル間隔（デフォルトは 0 分）。クエリの実行時に利用されます。当該値を変更することで、キャンセル処理を行う時間を設定できます。

戻り値

このフィルタは整数値（分）を返します。返された値に基づいて未払い注文のキャンセルが実行されます。

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

WooCommerce バージョン: 2.2 以上
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_filter('woocommerce_cancel_unpaid_orders_interval_minutes', 'set_custom_cancel_interval');

function set_custom_cancel_interval($minutes) {
    return 30; // 未払い注文を30分後にキャンセル
}

このサンプルは未払いの注文を30分後に自動的にキャンセルするよう設定します。

サンプル 2: 環境に応じた間隔の変更

add_filter('woocommerce_cancel_unpaid_orders_interval_minutes', 'dynamic_cancel_interval');

function dynamic_cancel_interval($minutes) {
    if (is_user_logged_in()) {
        return 15; // ログインユーザーには15分
    }
    return 60; // ゲストには60分
}

ここでは、ログインユーザーには15分、ゲストには60分の間隔で未払い注文をキャンセルする設定になっています。

サンプル 3: 現在の時刻に基づくカスタム間隔

add_filter('woocommerce_cancel_unpaid_orders_interval_minutes', 'conditional_cancel_interval');

function conditional_cancel_interval($minutes) {
    $hour = date('G'); // 現在の時刻を取得
    return ($hour >= 18) ? 120 : 30; // 18時以降は120分、それ以外は30分
}

このコードは、現在の時間が18時以降であれば未払い注文を120分後にキャンセルします。

サンプル 4: 環境変数に基づく設定

add_filter('woocommerce_cancel_unpaid_orders_interval_minutes', 'env_based_cancel_interval');

function env_based_cancel_interval($minutes) {
    $env = getenv('STORE_ENV'); // 環境変数を取得
    return ($env === 'production') ? 45 : 90; // 本番環境では45分、それ以外では90分
}

このサンプルでは、本番環境とそれ以外で異なるキャンセル間隔を設定しています。

サンプル 5: 設定オプションに基づく間隔

add_filter('woocommerce_cancel_unpaid_orders_interval_minutes', 'options_based_cancel_interval');

function options_based_cancel_interval($minutes) {
    $option_value = get_option('unpaid_order_cancel_time', 30); // デフォルトで30分
    return absint($option_value); // オプションから間隔を取得
}

この例では、管理画面の設定オプションに基づいて未払い注文のキャンセル間隔を動的に設定しています。

これらのサンプルコードは著作権フリーのものであり、オンラインストアのニーズに合わせてカスタマイズ可能です。

概要

構文