プラグインWooCommerceのwoocommerce_email_heading_customer_invoice_paidフィルタの使用方法・解説

概要

woocommerce_email_heading_customer_invoice_paid フィルタは、WooCommerceにおける顧客の請求書が支払われた際に送信されるメールのヘッダー文言をカスタマイズするためのフックです。このフィルタを使用することで、メールのヘッダーを変更したり、異なるタイトルを表示したりすることができます。このフィルタは主に以下のような場面でよく使用されます。

メールのブランディング強化
顧客に対する通知の明確化
異なる国や地域へのカスタマイズ
特定のプロモーションやキャンペーンに合わせたタイトル変更
自社のトーンに合わせたメッセージのカスタマイズ
マルチサイト環境での各サイトのカスタム設定

構文

add_filter('woocommerce_email_heading_customer_invoice_paid', 'your_custom_function', 10, 2);

パラメータ

$heading: 現在のヘッダー文言（文字列）。
$order: 対応する注文オブジェクト。

戻り値

このフィルタは、カスタマイズされたヘッダー文言（文字列）を返します。

使用可能なバージョン

WooCommerce: バージョン 2.1.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_filter('woocommerce_email_heading_customer_invoice_paid', 'custom_invoice_header', 10, 2);

function custom_invoice_header($heading, $order) {
    return 'ご入金ありがとうございます！';
}

このコードは、顧客が請求書を支払った際のメールヘッダーを「ご入金ありがとうございます！」に変更します。

サンプルコード2: 複数言語サポートを追加

add_filter('woocommerce_email_heading_customer_invoice_paid', 'multi_language_invoice_header', 10, 2);

function multi_language_invoice_header($heading, $order) {
    if (get_locale() == 'ja') {
        return '請求書が支払われました';
    }
    return 'Invoice Paid';
}

このコードは、言語に応じたメールヘッダーを設定します。日本語のロケールであれば「請求書が支払われました」、それ以外の場合は「Invoice Paid」と表示されます。

サンプルコード3: プロモーションに関連するヘッダー

add_filter('woocommerce_email_heading_customer_invoice_paid', 'promo_invoice_header', 10, 2);

function promo_invoice_header($heading, $order) {
    return '特別オファー！請求書が支払われました';
}

このコードは、プロモーション用のヘッダー文言を追加します。

サンプルコード4: ヘッダーに注文番号を追加

add_filter('woocommerce_email_heading_customer_invoice_paid', 'add_order_number_to_invoice_header', 10, 2);

function add_order_number_to_invoice_header($heading, $order) {
    return '請求書 (#' . $order->get_order_number() . ') が支払われました';
}

このコードは、請求書のヘッダーに注文番号を追加し、顧客により具体的な情報を提供します。

サンプルコード5: 日付を追加

add_filter('woocommerce_email_heading_customer_invoice_paid', 'add_date_to_invoice_header', 10, 2);

function add_date_to_invoice_header($heading, $order) {
    return '請求書が支払われました (' . date_i18n(wc_date_format(), strtotime($order->get_date_created())) . ')';
}

このコードは、請求書の日付をヘッダーに追加し、顧客に具体的な日付情報を提供します。

引用元ページは、WooCommerceの公式ドキュメントやWordPressの関連資料など、著作権フリーのリソースを参照ください。

概要

構文