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

概要

woocommerce_review_order_before_submit は、WooCommerce のチェックアウトページにおいて「注文確認」セクションが表示される直前にフックされるアクションです。このアクションは、カスタムフィールドや特別なメッセージを追加したり、再確認ボックスなどを設置したりするためによく使用されます。具体的には、以下のような機能を実装する際に役立ちます：

カスタムフィールドの追加
ユーザーへの特別なリマインダーや通知の表示
クーポンの適用オプションを追加
サードパーティサービスとの連携ボタンの追加
購入条件の同意チェックボックスの追加
顧客向けのプロモーション情報の表示

構文

do_action( 'woocommerce_review_order_before_submit' );

パラメータ

このアクションは特にパラメータを持ちません。

戻り値

戻り値はありません。

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

WooCommerce: 3.0以降
WordPress: 4.0以降

サンプルコード

サンプルコード1

add_action( 'woocommerce_review_order_before_submit', 'add_custom_message_before_submit' );

function add_custom_message_before_submit() {
    echo '<p class="custom-message">ご注文の前に、内容を確認してください。</p>';
}

このサンプルは、注文の前にカスタムメッセージを表示します。特に、顧客に対して最終確認を促すメッセージとして利用されます。
引用URL: https://woocommerce.com/

サンプルコード2

add_action( 'woocommerce_review_order_before_submit', 'add_terms_checkbox' );

function add_terms_checkbox() {
    echo '<div class="terms-checkbox">';
    echo '<input type="checkbox" required /> 規約に同意します。';
    echo '</div>';
}

このサンプルでは、購入手続きの前に規約への同意を確認するチェックボックスを追加します。顧客が購入する前に規約を確認させる目的で使われます。
引用URL: https://developer.woocommerce.com/

サンプルコード3

add_action( 'woocommerce_review_order_before_submit', 'display_discount_code_area' );

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

このサンプルは、チェックアウトページに割引コードを入力するフィールドを追加します。顧客が適切に割引を受けられるようにするための機能です。
引用URL: https://wpsitesuccess.com/

サンプルコード4

add_action( 'woocommerce_review_order_before_submit', 'add_final_reminder' );

function add_final_reminder() {
    echo '<p class="final-reminder">この最後のステージで、全て正しい情報を入力してください。</p>';
}

このサンプルは、チェックアウト時に最終確認のための提醒メッセージを表示します。顧客に注意を促すためのものです。
引用URL: https://www.example.com/

サンプルコード5

add_action( 'woocommerce_review_order_before_submit', 'show_payment_options' );

function show_payment_options() {
    echo '<div class="payment-options"><strong>お支払い方法:</strong> クレジットカードまたはPayPalが利用可能です。</div>';
}

このサンプルは、購入手続き中に利用できる支払いオプションを顧客に知らせるメッセージを表示します。便利な情報提供の一環として機能します。
引用URL: https://example.com/

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

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

概要

構文