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

概要

woocommerce_payment_gateway_save_new_payment_method_option_html アクションは、WooCommerce の新しい支払い方法オプションを保存する際にフックされるイベントです。このアクションを使用することで、開発者は支払い方法の保存に関連するカスタム処理を追加することができます。このアクションは、以下のような機能を実装する際によく使われます。

支払い方法の新しいオプションの保存処理のカスタマイズ。
ユーザーが支払い方法を保存する際のデータ検証の追加。
保存されたデータと他のシステムとの統合。
保存処理の後に通知を表示するカスタムメッセージの追加。
エラーハンドリングやログ記録の強化。
特定の条件に基づくカスタムロジックの実装。

構文

add_action( 'woocommerce_payment_gateway_save_new_payment_method_option_html', 'your_custom_function' );

パラメータ

$gateway_id (string): 保存される支払いゲートウェイのID。
$payment_method (array): 保存される新しい支払い方法の情報。

戻り値

このアクションは戻り値を持ちません。主に副作用を目的としています。

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

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_payment_gateway_save_new_payment_method_option_html', 'save_custom_payment_method_option', 10, 2 );

function save_custom_payment_method_option( $gateway_id, $payment_method ) {
    if ( isset( $_POST['custom_option'] ) ) {
        update_user_meta( get_current_user_id(), 'custom_option_' . $gateway_id, sanitize_text_field( $_POST['custom_option'] ) );
    }
}

サンプル2: データ検証の追加

このサンプルコードでは、支払い方法保存時にデータ検証を行います。

add_action( 'woocommerce_payment_gateway_save_new_payment_method_option_html', 'validate_payment_method_data', 10, 2 );

function validate_payment_method_data( $gateway_id, $payment_method ) {
    if ( empty( $_POST['payment_card_number'] ) ) {
        wc_add_notice( __( 'カード番号は必須です。', 'woocommerce' ), 'error' );
    }
}

サンプル3: エラーログの記録

このコードスニペットは、支払い方法の保存時にエラーをログに記録します。

add_action( 'woocommerce_payment_gateway_save_new_payment_method_option_html', 'log_payment_method_error', 10, 2 );

function log_payment_method_error( $gateway_id, $payment_method ) {
    if ( isset( $_POST['error'] ) && $_POST['error'] ) {
        error_log( '支払い方法保存時にエラーが発生しました: ' . $_POST['error'] );
    }
}

サンプル4: カスタムメッセージの表示

このサンプルは、支払い方法が正常に保存された際にメッセージを表示します。

add_action( 'woocommerce_payment_gateway_save_new_payment_method_option_html', 'custom_success_message', 10, 2 );

function custom_success_message( $gateway_id, $payment_method ) {
    wc_add_notice( __( '新しい支払い方法が正常に保存されました。', 'woocommerce' ), 'success' );
}

サンプル5: 条件に基づくカスタムロジックの実装

このコードは、特定の条件が満たされたときにのみ保存処理を実行します。

add_action( 'woocommerce_payment_gateway_save_new_payment_method_option_html', 'conditional_payment_method_processing', 10, 2 );

function conditional_payment_method_processing( $gateway_id, $payment_method ) {
    if ( isset( $_POST['should_save'] ) && $_POST['should_save'] === 'yes' ) {
        // 条件を満たす場合のみ処理を実行
        update_user_meta( get_current_user_id(), 'saved_payment_method', $payment_method );
    }
}

このサンプルコードはすべて著作権フリーです。

概要

構文