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

概要

woocommerce_checkout_order_review は、WooCommerce のチェックアウトページにおいて、注文のレビューセクションを表示する際にフックされるアクションです。このアクションは、チェックアウトプロセスをカスタマイズするためによく使用され、以下のような機能を実装する際に利用されることが多いです。

カスタムメッセージや情報の表示
フィールドの追加や削除
支払方法のカスタマイズ
クーポンコードの適用処理の変更
特別オファーの表示
コンバージョンキャンペーンのトラッキング

このアクションの構文は次のとおりです。

do_action( 'woocommerce_checkout_order_review' );

パラメータ

現在、woocommerce_checkout_order_review アクションは特にカスタムパラメータを持っていません。

戻り値

このアクション自体は値を返しませんが、フックされた関数によって出力が生成されることがあります。

使用可能なバージョン

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_checkout_order_review', 'add_custom_checkout_message' );
function add_custom_checkout_message() {
    echo '<div class="custom-message">特別なオファー! 今すぐご利用いただけます。</div>';
}

引用元: https://example.com/sample1

サンプルコード 2

このサンプルは、支払方法を強調表示します。

add_action( 'woocommerce_checkout_order_review', 'highlight_payment_method' );
function highlight_payment_method() {
    echo '<style>.payment_method {background: #f1f1f1;}</style>';
}

引用元: https://example.com/sample2

サンプルコード 3

このサンプルは、クーポンコードを適用するボタンを追加します。

add_action( 'woocommerce_checkout_order_review', 'add_coupon_button' );
function add_coupon_button() {
    echo '<button class="apply-coupon">クーポンを適用する</button>';
}

引用元: https://example.com/sample3

サンプルコード 4

このサンプルは、新しいフィールドを追加します。

add_action( 'woocommerce_checkout_order_review', 'add_custom_field' );
function add_custom_field() {
    echo '<label for="custom_field">カスタムフィールド:</label>';
    echo '<input type="text" id="custom_field" name="custom_field" />';
}

引用元: https://example.com/sample4

サンプルコード 5

このサンプルは、エラーメッセージを表示します。

add_action( 'woocommerce_checkout_order_review', 'show_custom_error_message' );
function show_custom_error_message() {
    echo '<div class="error-message">注意: すべてのフィールドを正しく入力してください。</div>';
}

引用元: https://example.com/sample5

概要