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

概要

woocommerce_checkout_before_terms_and_conditionsはWooCommerceのチェックアウトページで、利用規約に関するセクションの前にフックされているアクションです。このアクションは、主に以下のような機能を実装する際に使用されます。

追加情報を表示する
カスタムフィールドを追加する
プロモーションメッセージを表示する
ユーザーガイドラインを提供する
信用情報や規約へのリンクを追加する
セキュリティ警告やプライバシーポリシーを表示する

構文

do_action( 'woocommerce_checkout_before_terms_and_conditions' );

パラメータ

このアクションにはデフォルトでパラメータはありませんが、他のフックと組み合わせることで、必要なデータを利用できます。

戻り値

戻り値は特にありません。主に副作用として内容が出力されます。

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

WooCommerceバージョン: 3.0.0以降

使用可能なワードプレスのバージョン

WordPressバージョン: 4.0.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_before_terms_and_conditions', 'add_custom_message' );

function add_custom_message() {
    echo '<div class="custom-message">ご注意: 利用規約をよくお読みください。</div>';
}

サンプルコード2: カスタムフィールドの追加

このコードは、チェックアウトページにカスタムフィールドを追加します。

add_action( 'woocommerce_checkout_before_terms_and_conditions', 'add_custom_checkout_field' );

function add_custom_checkout_field() {
    echo '<p class="form-row terms">'
       . '<label for="custom_field">特別なリクエスト：</label>'
       . '<input type="text" class="input-text" name="custom_field" id="custom_field" />'
       . '</p>';
}

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

このコードは、プロモーションバナーを表示します。

add_action( 'woocommerce_checkout_before_terms_and_conditions', 'add_promotion_banner' );

function add_promotion_banner() {
    echo '<div class="promo-banner">今なら送料無料キャンペーン中！</div>';
}

サンプルコード4: 規約へのリンクを追加

このコードは、チェックアウトページに規約へのリンクを追加します。

add_action( 'woocommerce_checkout_before_terms_and_conditions', 'add_terms_link' );

function add_terms_link() {
    echo '<p><a href="'.esc_url( get_permalink( get_option('woocommerce_terms_page_id') ) ).'">利用規約を読む</a></p>';
}

サンプルコード5: セキュリティ警告の表示

このコードは、セキュリティ警告を表示します。

add_action( 'woocommerce_checkout_before_terms_and_conditions', 'add_security_warning' );

function add_security_warning() {
    echo '<div class="security-warning">あなたの情報は安全に保護されています。</div>';
}

概要

構文