概要
woocommerce_pay_order_before_submit アクションは、WooCommerceのチェックアウトページで、注文が送信される直前にフックされるイベントです。このアクションを使用することで、開発者はさまざまなカスタマイズを行うことができます。一般的な使用例としては、次のような機能があります。
- 追加の説明文や注意事項を表示する。
- カスタムフィールドを挿入して情報を収集する。
- セキュリティメッセージや合法性に関する文言を追加する。
- プロモーションや特別オファーを宣伝する。
- 支払い方法に関する追加情報を提供する。
- ユーザーの確認や承認を要求するチェックボックスを追加する。
構文
add_action( 'woocommerce_pay_order_before_submit', 'your_custom_function' );
パラメータ
このアクションには特定の引数は渡されませんが、WooCommerceのチェックアウトコンテキストで実行されるため、グローバル変数や他のWooCommerce関数にアクセス可能です。
戻り値
このアクションは戻り値を持ちません。出力に対して影響を与えるのみです。
使用可能なプラグインWooCommerceのバージョン
このアクションはWooCommerceのバージョン3.0以降で使用可能です。
ワードプレスのバージョン
WordPressのバージョン4.0以降で動作します。
サンプルコード
サンプル1: 注意事項を表示
add_action( 'woocommerce_pay_order_before_submit', 'display_notice_before_payment' );
function display_notice_before_payment() {
echo '<p class="notice">ご注文を確認して、次に進んでください。</p>';
}
このサンプルコードでは、注文の支払い前に注意事項を表示します。このようにして顧客に対して明確な説明を与えることができます。
出典: https://woocommerce.com/
サンプル2: カスタムフィールドの挿入
add_action( 'woocommerce_pay_order_before_submit', 'add_custom_field_before_payment' );
function add_custom_field_before_payment() {
echo '<label for="custom_field">カスタム情報:</label>';
echo '<input type="text" id="custom_field" name="custom_field" />';
}
このコードは、支払い前にカスタム入力フィールドを追加して、追加情報を取得するものです。
出典: https://woocommerce.com/
サンプル3: セキュリティメッセージの追加
add_action( 'woocommerce_pay_order_before_submit', 'add_security_message' );
function add_security_message() {
echo '<div class="security-message">すべての取引は安全です。</div>';
}
こちらのサンプルでは、顧客に取引の安全性を保証するメッセージを表示しています。
出典: https://woocommerce.com/
サンプル4: プロモーションを表示
add_action( 'woocommerce_pay_order_before_submit', 'show_promotion_message' );
function show_promotion_message() {
echo '<p class="promotion-message">次回の購入に利用できる10％オフのクーポンコードを取得!</p>';
}
この例では、支払い前に顧客に対してプロモーションメッセージを表示します。
出典: https://woocommerce.com/
サンプル5: ユーザーの確認チェックボックス
add_action( 'woocommerce_pay_order_before_submit', 'add_confirmation_checkbox' );
function add_confirmation_checkbox() {
echo '<input type="checkbox" id="confirm_terms" name="confirm_terms" required>';
echo '<label for="confirm_terms">利用規約に同意します</label>';
}
このサンプルでは、顧客が支払いを完了する前に利用規約への同意を求めるチェックボックスを追加しています。
出典: https://woocommerce.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 |