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

概要

woocommerce_checkout_before_order_review_headingは、WooCommerceプラグインのチェックアウトページで、注文レビューの見出しの前にフックするためのアクションです。このアクションは、主に次のような機能を実装する際に利用されます：

注文レビューセクションのカスタマイズ
ユーザーへの追加情報の表示
特定の条件に基づくコンテンツの表示
デザインやレイアウトの調整
プロモーション情報やコードの表示
サイトに特有な機能の追加

構文

add_action( 'woocommerce_checkout_before_order_review_heading', 'your_custom_function' );

パラメータ

このアクション自体は、パラメータを持っていません。

戻り値

戻り値はありません。このアクションは、カスタム出力を行うことが目的です。

使用可能なバージョン

WooCommerce: 3.0.x 以降
WordPress: 4.0 以降

サンプルコード

サンプルコード1

add_action('woocommerce_checkout_before_order_review_heading', 'custom_checkout_message');
function custom_checkout_message() {
    echo '<h3>特別なメッセージ！</h3>';
}

このサンプルコードは、チェックアウトページで注文レビューの見出しの前に特別なメッセージを表示します。

サンプルコード2

add_action('woocommerce_checkout_before_order_review_heading', 'display_coupon_code_section');
function display_coupon_code_section() {
    echo '<p>クーポンコードをお持ちですか？</p>';
}

このコードは、クーポンコードの入力を促すメッセージをチェックアウトページに追加します。

サンプルコード3

add_action('woocommerce_checkout_before_order_review_heading', 'add_custom_notice');
function add_custom_notice() {
    echo '<div class="custom-notice">限定セール中！全アイテム10%オフ！</div>';
}

このサンプルコードでは、チェックアウトページに期間限定のセール通知を追加します。

サンプルコード4

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

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

サンプルコード5

add_action('woocommerce_checkout_before_order_review_heading', 'show_delivery_options');
function show_delivery_options() {
    echo '<p>配送オプションを選択してください。</p>';
}

このサンプルコードは、利用者に配送オプションを選択するよう促すメッセージを表示します。

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

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

概要

構文