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

概要

woocommerce_before_order_notes は WooCommerce のチェックアウトフォームに関連するアクションフックです。このフックは、注文確認ページの「注文ノート」セクションの前にカスタムコードを挿入するために使用されます。主に以下のような機能を実装する際に利用されます。

カスタムメッセージの表示
特別な注意事項の追加
プロモーションコードの入力フィールドの追加
利用規約への同意チェックボックスの追加
カスタムフィールドの追加
ユーザーインターフェイスの最適化

構文

add_action('woocommerce_before_order_notes', 'your_custom_function');

パラメータ

なし

戻り値

なし

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

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_before_order_notes', 'custom_checkout_notes_message');
function custom_checkout_notes_message() {
    echo '<p class="custom-notice">ご注文の際は特別な注意事項を忘れずにご記入ください。</p>';
}

このコードは、注文ノートの前にカスタムメッセージを表示するものです。

サンプルコード 2

add_action('woocommerce_before_order_notes', 'add_custom_checkbox');
function add_custom_checkbox() {
    echo '<div><label><input type="checkbox" required /> 利用規約に同意します。</label></div>';
}

このコードは、利用規約に同意するためのチェックボックスを追加します。

サンプルコード 3

add_action('woocommerce_before_order_notes', 'add_promo_code_field');
function add_promo_code_field() {
    echo '<div class="promo-code"><label for="promo_code">プロモーションコード:</label><input type="text" name="promo_code" id="promo_code" /></div>';
}

このコードは、プロモーションコードを入力するためのフィールドを追加します。

サンプルコード 4

add_action('woocommerce_before_order_notes', 'custom_checkout_field');
function custom_checkout_field() {
    echo '<div class="custom-field"><label for="custom_field">カスタムフィールド:</label><input type="text" name="custom_field" id="custom_field" /></div>';
}

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

サンプルコード 5

add_action('woocommerce_before_order_notes', 'display_special_message');
function display_special_message() {
    if (is_user_logged_in()) {
        echo '<p>ご利用ありがとうございます！あなたはログイン中です。</p>';
    }
}

このコードは、ユーザーがログインしている場合に特別なメッセージを表示します。

概要

構文