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

概要

woocommerce_review_order_before_payment は、WooCommerce のチェックアウトプロセスにおいて、支払いセクションの前に特定のカスタム機能や内容を挿入したい場合に使用するフックです。このアクションは、特に次のような機能を実装する際に役立ちます。

支払いオプションの前にカスタムメッセージを表示する
二次的な情報（例えば、割引コードの入力フォームなど）を表示する
モバイル決済の案内やバナーを表示する
ボタンやリンクを追加して、他のサービスやプロモーションを案内する
ユーザーに確認メッセージを表示する
入力されたデータに基づいて動的な情報を示す

このアクションの構文は以下の通りです。

do_action( 'woocommerce_review_order_before_payment' );

パラメータ

このアクションは、特定のパラメータを持っていません。

戻り値

戻り値はありません。サイドエフェクトを持つ内容を出力するために使用されます。

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

WooCommerce 2.0以降

使用可能な WordPress のバージョン

WordPress 4.0以降

サンプルコード

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

カスタムメッセージを支払いオプションの前に表示するサンプルコードです。

add_action( 'woocommerce_review_order_before_payment', 'custom_payment_message' );

function custom_payment_message() {
    echo '<p>お支払いの前に、以下の注意点をご確認ください。</p>';
}

このコードは、支払いセクションの前に注意点のメッセージを表示します。

サンプル 2: 割引コード入力フォームの追加

支払いオプションの前に割引コード入力フォームを追加するサンプルです。

add_action( 'woocommerce_review_order_before_payment', 'add_discount_code_field' );

function add_discount_code_field() {
    echo '<div class="discount_code"><label for="discount_code">割引コード:</label><input type="text" id="discount_code" name="discount_code" /></div>';
}

このコードは、ユーザーが割引コードを入力できるフィールドを追加します。

サンプル 3: プロモーションバナーの表示

支払いオプションの前にプロモーションバナーを表示するサンプルです。

add_action( 'woocommerce_review_order_before_payment', 'show_promotion_banner' );

function show_promotion_banner() {
    echo '<div class="promotion_banner">今なら、全商品10%オフキャンペーン中！</div>';
}

このサンプルでは、支払いセクションの前にプロモーションに関するメッセージを表示します。

サンプル 4: モバイル決済の案内

モバイル決済を促す案内を支払いオプションの前に表示するサンプルです。

add_action( 'woocommerce_review_order_before_payment', 'mobile_payment_info' );

function mobile_payment_info() {
    echo '<p>モバイル決済をご利用の方は、QRコードをスキャンしてください。</p>';
}

このコードは、モバイル決済を利用するユーザーに向けたメッセージを表示します。

サンプル 5: 確認メッセージの表示

支払いオプションの前に確認メッセージを表示するサンプルです。

add_action( 'woocommerce_review_order_before_payment', 'confirmation_message_before_payment' );

function confirmation_message_before_payment() {
    echo '<div class="confirmation_message">お支払い内容をご確認の上、手続きを進めてください。</div>';
}

このコードは、ユーザーにお支払い内容を確認するよう促すメッセージを表示します。

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

アクション	使用例
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

概要