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

概要

woocommerce_email_description フィルタは、WooCommerce のメール機能において、メールの説明文をカスタマイズするためのフックです。このフィルタは、特定のメールを送信する際に、説明文を変更したい場合に使用されます。たとえば、注文確認メールや発送通知メールの内容を調整する際に役立ちます。

よく使われる機能

注文確認メールの説明文をカスタマイズする
請求書メールに追加情報を追加する
顧客への印象を向上させるためのブランドメッセージを挿入する
特定の条件に応じて異なる説明文を表示する
特定のタイミングで新しいプロモーション情報を追加する
メールテンプレート全体のデザイン統一のために説明文を変更する

フィルタの概要

構文:

add_filter( 'woocommerce_email_description', 'custom_email_description', 10, 2 );

パラメータ:
- $description: 変更するメールの説明文
- $email_id: 現在のメールの ID
戻り値: フィルタされた説明文を返します。
使用可能なプラグイン WooCommerce のバージョン: 4.0以上
ワードプレスのバージョン: 5.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_description', 'custom_order_email_description', 10, 2 );

function custom_order_email_description( $description, $email_id ) {
    if ( 'customer_order' === $email_id ) {
        $description = 'ありがとう！あなたの注文が受け付けられました。';
    }
    return $description;
}

このコードは、注文確認メールの説明文を「ありがとう！あなたの注文が受け付けられました。」に変更します。

サンプル2: 請求書メールにプロモーション情報を追加する

add_filter( 'woocommerce_email_description', 'add_promotion_to_invoice', 10, 2 );

function add_promotion_to_invoice( $description, $email_id ) {
    if ( 'customer_invoice' === $email_id ) {
        $description .= ' 今なら10%オフのクーポンコードが使えます！';
    }
    return $description;
}

このコードは、請求書メールの説明文にプロモーション情報を追加します。

サンプル3: 休日のメッセージを追加する

add_filter( 'woocommerce_email_description', 'holiday_message_in_email', 10, 2 );

function holiday_message_in_email( $description, $email_id ) {
    $current_month = date( 'n' );
    if ( $current_month === 12 ) {
        $description .= ' 祝！ホリデーシーズンをお楽しみください。';
    }
    return $description;
}

このコードは、12月に送信されるメールにホリデーシーズンのメッセージを追加します。

サンプル4: 特定のメールにのみ広告を追加する

add_filter( 'woocommerce_email_description', 'append_advertisement_to_specific_email', 10, 2 );

function append_advertisement_to_specific_email( $description, $email_id ) {
    if ( 'customer_completed_order' === $email_id ) {
        $description .= ' ぜひ次回の注文で使えるクーポンをチェックしてください！';
    }
    return $description;
}

このコードは、注文完了メールに特定の広告メッセージを追加します。

サンプル5: カスタム条件に基づいて説明文を変更する

add_filter( 'woocommerce_email_description', 'conditional_email_description', 10, 2 );

function conditional_email_description( $description, $email_id ) {
    if ( 'customer_processing_order' === $email_id && is_user_logged_in() ) {
        $description = 'ログインしてくれてありがとう、あなたの注文は処理中です。';
    }
    return $description;
}

このコードは、ログインしているユーザーの注文処理メールの説明文をカスタマイズします。

以上が、woocommerce_email_description フィルタを使用したサンプルコードとその解説です。これらを参考にして、メールの内容をより効果的にカスタマイズしてください。

概要