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

概要

woocommerce_add_payment_method_form_bottom アクションは、WooCommerceが新しい支払い方法を追加する際のフォームの底部にフックを挿入するために使用されます。このアクションは、ユーザーが支払い方法を追加する際のフォームにカスタムフィールドや追加の情報を挿入する場合によく利用されます。

具体的な機能としては以下のようなシナリオで活用されることが多いです。

カスタムアラートメッセージの表示
特定の条件に基づく入力フィールドの追加
ユーザーへの説明文や注意書きの挿入
オプション機能の選択肢の追加
マーケティング情報の提示
ウェブサイトのブランディング要素を追加

構文

add_action('woocommerce_add_payment_method_form_bottom', 'your_function_name');

パラメータ

このアクションには特定のパラメータはありませんが、呼び出されたときのコンテキストに応じて処理を変更することができます。

戻り値

このアクション自体は値を返しません。アクション内部で処理した結果は、フォームに直接影響を与えます。

使用可能なプラグイン

WooCommerce バージョン: 5.x以降
WordPress バージョン: 5.x以降

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

使用可能なアクション	使用例
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_add_payment_method_form_bottom', 'add_custom_message');
function add_custom_message() {
    echo '<p class="custom-message">お支払い情報をしっかりとご確認ください。</p>';
}

このサンプルコードは、支払い方法追加フォームの底部にカスタムメッセージを表示します。

サンプルコード2

add_action('woocommerce_add_payment_method_form_bottom', 'add_custom_input_field');
function add_custom_input_field() {
    echo '<p><label for="custom_field">カスタムフィールド:</label><input type="text" id="custom_field" name="custom_field" /></p>';
}

このコードは、新しい支払い方法追加フォームにカスタム入力フィールドを追加します。

サンプルコード3

add_action('woocommerce_add_payment_method_form_bottom', 'display_terms_and_conditions');
function display_terms_and_conditions() {
    echo '<p>お支払い方法を選択することで、<a href="/terms">利用規約</a>に同意したことになります。</p>';
}

このサンプルでは、利用規約へのリンクを含む説明文を追加しています。

サンプルコード4

add_action('woocommerce_add_payment_method_form_bottom', 'add_special_offer');
function add_special_offer() {
    echo '<p class="special-offer">今なら新しい支払い方法を追加すると10%オフ！</p>';
}

このコードは、新しい支払い方法追加時に特別オファーを表示します。

サンプルコード5

add_action('woocommerce_add_payment_method_form_bottom', 'insert_branding_message');
function insert_branding_message() {
    echo '<p class="branding-message">XX社の指定支払い方法です。</p>';
}

このサンプルコードでは、ブランドメッセージを追加して、特定の支払い方法が関連することを利用者に知らせます。

概要

構文