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

概要

woocommerce_review_order_after_paymentは、WooCommerceの注文確認画面で、支払い情報のセクションの後にカスタムコンテンツを追加するためのフックです。このアクションは、さまざまな機能を実装する際によく使用されます。具体的には、次のようなシナリオで役立ちます：

カスタムメッセージの表示
特別なプロモーションや割引の通知
支払いオプションの条件付き表示
必要な利用規約やポリシーへのリンク提供
顧客向けの追加情報（例：配送オプション）
サードパーティのトラッキングコードの挿入

構文

add_action('woocommerce_review_order_after_payment', 'your_custom_function');

function your_custom_function() {
    // コードをここに追加
}

パラメータ

このアクションは、特にパラメータを取らずに実行されます。そのため、関数内で特定の引数を取得することはありません。

戻り値

このアクション自体は戻り値を持ちませんが、その中で出力されるHTMLは含まれるコンテンツに依存します。

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

WooCommerce バージョン：5.0以降
WordPress バージョン：5.0以降

サンプルコード

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

このコードは、支払いセクションの後に特定のカスタムメッセージを表示します。

add_action('woocommerce_review_order_after_payment', 'display_custom_message');

function display_custom_message() {
    echo '<div class="custom-message">ご注文いただきありがとうございます！</div>';
}

サンプルコード 2：プロモーションバナーの表示

このコードは、支払いセクションの後にプロモーションバナーを追加します。

add_action('woocommerce_review_order_after_payment', 'display_promotion_banner');

function display_promotion_banner() {
    echo '<div class="promotion-banner">今だけ、全品10%オフクーポンコードを使用できます！</div>';
}

サンプルコード 3：利用規約へのリンク

このコードは、支払いセクションの後に利用規約のリンクを追加します。

add_action('woocommerce_review_order_after_payment', 'add_terms_link');

function add_terms_link() {
    echo '<p>ご利用規約は<a href="/terms">こちら</a>をご確認ください。</p>';
}

サンプルコード 4：追加情報の表示

このコードは、支払いセクションの後に追加情報を表示します。

add_action('woocommerce_review_order_after_payment', 'display_additional_info');

function display_additional_info() {
    echo '<div class="additional-info">配送方法や商品についての詳細はマイアカウントをご覧ください。</div>';
}

サンプルコード 5：サードパーティによるトラッキングコードの挿入

このコードは、支払いセクションの後にトラッキングコードを挿入します。

add_action('woocommerce_review_order_after_payment', 'insert_tracking_code');

function insert_tracking_code() {
    echo '<script>/* トラッキングコード */</script>';
}

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

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

概要

構文