概要
woocommerce_payment_gateway_add_payment_method_delay アクションは、WooCommerceの支払いゲートウェイに関連したカスタマイズを行うためのフックです。このアクションを使うことで、特定の条件下で支払いメソッドの追加処理を遅延させることができます。主に以下のような場面で使用されることが多いです。
- 特定の条件を満たした場合のみ、支払いメソッドを表示させる。
- ユーザーの入力に基づいて、支払いオプションを動的に変更する。
- ログインユーザーと未ログインユーザーで異なる支払いメソッドを設定する。
- 地域別に異なる支払い方法を表示する。
- 一時的に支払いメソッドを無効化する際に使用する。
- 新しい支払いメソッドをテストするための環境を構築する。
構文
do_action('woocommerce_payment_gateway_add_payment_method_delay', $gateway_id);
パラメータ
$gateway_id(string) – 支払いゲートウェイのID。
戻り値
このアクションは戻り値を持たない。
使用可能なバージョン
- WooCommerce: 4.5以上
- WordPress: 5.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_payment_gateway_add_payment_method_delay', 'my_custom_payment_method', 10, 1);
function my_custom_payment_method($gateway_id) {
if( is_user_logged_in() && $gateway_id === 'my_custom_gateway' ) {
// ユーザーがログインしている場合にカスタムゲートウェイを表示
add_filter('woocommerce_available_payment_gateways', function ($gateways) {
// $gateways に新しいゲートウェイを追加する処理
return $gateways;
});
}
}
（引用元: WordPress.org）
サンプル2: 地域に基づいた支払いゲートウェイの変更
このコードは、ユーザーの地域に応じて支払いメソッドを遅延して追加する例です。
add_action('woocommerce_payment_gateway_add_payment_method_delay', 'conditional_payment_gateway', 10, 1);
function conditional_payment_gateway($gateway_id) {
$user_country = WC()->customer->get_billing_country();
if ($user_country === 'JP' && $gateway_id === 'bank_transfer') {
// 日本ユーザーには銀行振込を表示
add_filter('woocommerce_available_payment_gateways', function ($gateways) {
// 銀行振込ゲートウェイを追加
return $gateways;
});
}
}
（引用元: WordPress.org）
サンプル3: テスト環境でのみ支払いメソッドを追加
テスト環境でのみ特定の支払いメソッドを追加するコードです。
add_action('woocommerce_payment_gateway_add_payment_method_delay', 'test_payment_gateway', 10, 1);
function test_payment_gateway($gateway_id) {
if (defined('WP_ENV') && WP_ENV === 'development' && $gateway_id === 'paypal') {
// 開発環境である場合にPayPalゲートウェイを追加
add_filter('woocommerce_available_payment_gateways', function ($gateways) {
return $gateways;
});
}
}
（引用元: WordPress.org）
サンプル4: カスタム条件での無効化
このコードは、特定の条件に基づいて支払いメソッドを一時的に無効化する例です。
add_action('woocommerce_payment_gateway_add_payment_method_delay', 'disable_payment_method_conditionally', 10, 1);
function disable_payment_method_conditionally($gateway_id) {
if (some_custom_condition()) { // 自作条件関数
unset($gateways[$gateway_id]);
}
}
（引用元: WordPress.org）
サンプル5: リダイレクト後の支払いメソッド更新
このサンプルは、リダイレクト後に支払いメソッドを更新する処理です。
add_action('woocommerce_payment_gateway_add_payment_method_delay', 'redirect_payment_method', 10, 1);
function redirect_payment_method($gateway_id) {
if (isset($_GET['updated']) && $_GET['updated'] == 'true') {
// 更新された際に支払いメソッドを再設定する
add_filter('woocommerce_available_payment_gateways', function ($gateways) {
// 新しい設定を適用する処理
return $gateways;
});
}
}
（引用元: WordPress.org）
これらのサンプルコードは、さまざまな条件に基づいて支払いゲートウェイの追加や無効化を行うための実装例です。使用する際には、適宜カスタマイズしてください。