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

概要

woocommerce_email_before_order_tableは、WooCommerceのメールテンプレートで注文テーブルが表示される前に実行されるフックです。このアクションは、カスタムメッセージや追加情報をメールに挿入する際に役立ちます。以下のようなシナリオでよく使用されます：

1. 注文確認メールにおけるカスタムメッセージの追加
2. 顧客向けの特別なオファーやプロモーションを表示
3. 注文内容に関する追加的な情報やヒントを提供
4. パートナーシップや連携の情報を提供
5. サポート情報や連絡先の追加
6. 顧客への感謝のメッセージを送信

構文

do_action('woocommerce_email_before_order_table', $order, $sent_to_admin, $plain_text, $email);

パラメータ

• $order: WC_Orderオブジェクト、注文情報。
• $sent_to_admin: bool、管理者に送信される場合はtrue。
• $plain_text: bool、プレーンテキストメールの場合はtrue。
• $email: WooCommerceのEmailオブジェクト。

戻り値

このアクションは戻り値を持たず、フックにより処理を追加するために使用されます。

バージョン情報

• 使用可能なWooCommerceのバージョン: 2.1 〜 最新
• 使用可能な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_email_before_order_table', 'add_custom_message_to_email', 10, 4);

function add_custom_message_to_email($order, $sent_to_admin, $plain_text, $email) {
    echo '<p>ご注文いただきありがとうございます！</p>';
}

引用元: https://woocommerce.com

サンプル2: 特別なオファーの追加

このコードは、特別なオファーをメールに追加します。

add_action('woocommerce_email_before_order_table', 'add_special_offer_to_email', 10, 4);

function add_special_offer_to_email($order, $sent_to_admin, $plain_text, $email) {
    echo '<p>次回ご利用いただける10%割引クーポンコード: SPECIAL10</p>';
}

引用元: https://woocommerce.com

サンプル3: サポート情報の表示

このコードは、顧客にサポート情報を知らせるためのメッセージを追加します。

add_action('woocommerce_email_before_order_table', 'add_support_info_to_email', 10, 4);

function add_support_info_to_email($order, $sent_to_admin, $plain_text, $email) {
    echo '<p>ご不明点がございましたら、support@example.comまでご連絡ください。</p>';
}

引用元: https://woocommerce.com

サンプル4: 加盟店の情報を表示

このコードは、提携先の情報をメールに追加します。

add_action('woocommerce_email_before_order_table', 'add_partner_info_to_email', 10, 4);

function add_partner_info_to_email($order, $sent_to_admin, $plain_text, $email) {
    echo '<p>このメールはXYZパートナーと提携してお届けしています。</p>';
}

引用元: https://woocommerce.com

サンプル5: 感謝のメッセージの追加

このコードは、顧客に感謝のメッセージを送ります。

add_action('woocommerce_email_before_order_table', 'add_thank_you_message_to_email', 10, 4);

function add_thank_you_message_to_email($order, $sent_to_admin, $plain_text, $email) {
    echo '<p>再度のご利用、誠にありがとうございます！</p>';
}

引用元: https://woocommerce.com