WooCommerce 创建自定义邮件（2022）

最后更新于 2022 年 10 月 14 日

除了更改WooCommerce邮件的样子外，还可以创建自定义的邮件。发件人、发送内容都可以定制。比如每个产品有不同的供货商，客户下单后要给每个供货商发送邮件，或者要发一些产品你使用说明给客户等等。

创建插件

在wp-content/plugins目录下创建文件夹my-custom-wc-email来保存代码，插件的目录结构如下：

└─my-custom-wc-email
    │  class-wc-custom-email.php
    │  plugin.php
    │
    └─emails
            my-custom-email-plain.php
            my-custom-email.php

每个文件的用途如下：

• plugin.php： 插件主文件，包含插件的header信息，以及核心功能：注册自定义邮件
• class-wc-custom-email.php：实现自定义邮件类
• emails/***.php：邮件的html模板和plain text模板

注册自定义邮件

plugin.php的内容如下：

<?php
/**
 * Plugin Name:       Custom WooCommerce Email Example
 * Plugin URI:        https://www.solagirl.net
 * Description:       Custom WooCommerce Email Example
 * Version:           1.0.0
 * Author:            Sola
 * Author URI:        https://www.solagirl.net
 * License:           GPL v2 or later
 * License URI:       https://www.gnu.org/licenses/gpl-2.0.html
 * Update URI:        https://example.com/my-plugin/
 * Text Domain:       cwe
 * Domain Path:       /languages
 */

// Exit if accessed directly
if (!defined('ABSPATH')) exit;

function sola_add_custom_woocommerce_email( $email_classes ) {

    // include our custom email class
    include( 'class-wc-custom-email.php' );

    // add the email class to the list of email classes that WooCommerce loads
    $email_classes['Sola_WC_Custom_Email'] = new Sola_WC_Custom_Email();

    return $email_classes;

}
add_filter( 'woocommerce_email_classes', 'sola_add_custom_woocommerce_email' );

1. 定义插件header信息
2. 通过filter: woocommerce_email_classes向WooCommerce注册一个新的邮件，具体实现email的class需要通过include文件的方式引入。因为该class要以WC_Email class为模板来创建，如果不在这里include，可能会遇到WC_Email未定义的错误。

以WC_Email为模板创建自定义邮件的class

class-wc-custom-email.php的内容如下：

<?php
// Exit if accessed directly
if (!defined('ABSPATH')) exit;

if (!class_exists('Sola_WC_Custom_Email')) :

  class Sola_WC_Custom_Email extends WC_Email {
    /**
     * Constructor.
     */
    public function __construct() {
      $this->id             = 'my_custom_email';
      $this->title          = __('My Custom Email', 'woocommerce');
      $this->description    = __('This is an example of WooCommerce Custom Email', 'woocommerce');

      // 将email templates存储在插件的目录下
      $this->template_base  = __DIR__ . '/emails/';
      $this->template_html  = 'my-custom-email.php';
      $this->template_plain = 'my-custom-email-plain.php';

      $this->placeholders   = array(
        '{order_date}'   => '',
        '{order_number}' => '',
      );

      // Triggers for this email.
      add_action('woocommerce_order_status_pending_to_processing_notification', array($this, 'trigger'), 10, 2);
      add_action('woocommerce_order_status_pending_to_completed_notification', array($this, 'trigger'), 10, 2);
      add_action('woocommerce_order_status_pending_to_on-hold_notification', array($this, 'trigger'), 10, 2);
      add_action('woocommerce_order_status_failed_to_processing_notification', array($this, 'trigger'), 10, 2);
      add_action('woocommerce_order_status_failed_to_completed_notification', array($this, 'trigger'), 10, 2);
      add_action('woocommerce_order_status_failed_to_on-hold_notification', array($this, 'trigger'), 10, 2);
      add_action('woocommerce_order_status_cancelled_to_processing_notification', array($this, 'trigger'), 10, 2);
      add_action('woocommerce_order_status_cancelled_to_completed_notification', array($this, 'trigger'), 10, 2);
      add_action('woocommerce_order_status_cancelled_to_on-hold_notification', array($this, 'trigger'), 10, 2);

      // Call parent constructor.
      parent::__construct();

      // Other settings.
      $this->recipient = $this->get_option('recipient', get_option('admin_email'));
    }

    /**
     * Get email subject.
     *
     * @since  3.1.0
     * @return string
     */
    public function get_default_subject() {
      return __('[{site_title}]: My Custom Email #{order_number}', 'woocommerce');
    }

    /**
     * Get email heading.
     *
     * @since  3.1.0
     * @return string
     */
    public function get_default_heading() {
      return __('My Custom Email: #{order_number}', 'woocommerce');
    }

    /**
     * Trigger the sending of this email.
     *
     * @param int            $order_id The order ID.
     * @param WC_Order|false $order Order object.
     */
    public function trigger($order_id, $order = false) {
      $this->setup_locale();

      if ($order_id && !is_a($order, 'WC_Order')) {
        $order = wc_get_order($order_id);
      }

      if (is_a($order, 'WC_Order')) {
        $this->object                         = $order;
        $this->placeholders['{order_date}']   = wc_format_datetime($this->object->get_date_created());
        $this->placeholders['{order_number}'] = $this->object->get_order_number();

        $email_already_sent = $order->get_meta('_new_order_email_sent');
      }

      /**
       * Controls if new order emails can be resend multiple times.
       *
       * @since 5.0.0
       * @param bool $allows Defaults to false.
       */
      if ('true' === $email_already_sent && !apply_filters('woocommerce_new_order_email_allows_resend', false)) {
        return;
      }

      if ($this->is_enabled() && $this->get_recipient()) {

        // 发送email
        $this->send($this->get_recipient(), $this->get_subject(), $this->get_content(), $this->get_headers(), $this->get_attachments());

        $order->update_meta_data('_new_order_email_sent', 'true');
        $order->save();
      }

      $this->restore_locale();
    }

    /**
     * Get content html.
     *
     * @return string
     */
    public function get_content_html() {
      return wc_get_template_html(
        $this->template_html,
        array(
          'order'              => $this->object,
          'email_heading'      => $this->get_heading(),
          'additional_content' => $this->get_additional_content(),
          'sent_to_admin'      => true,
          'plain_text'         => false,
          'email'              => $this,
        ),
        $this->template_base,
        $this->template_base
      );
    }

    /**
     * Get content plain.
     *
     * @return string
     */
    public function get_content_plain() {
      return wc_get_template_html(
        $this->template_plain,
        array(
          'order'              => $this->object,
          'email_heading'      => $this->get_heading(),
          'additional_content' => $this->get_additional_content(),
          'sent_to_admin'      => true,
          'plain_text'         => true,
          'email'              => $this,
        ),
        $this->template_base,
        $this->template_base
      );
    }

    /**
     * Default content to show below main email content.
     *
     * @since 3.7.0
     * @return string
     */
    public function get_default_additional_content() {
      return __('Congratulations on the sale.', 'woocommerce');
    }

    /**
     * Initialise settings form fields.
     */
    public function init_form_fields() {
      /* translators: %s: list of placeholders */
      $placeholder_text  = sprintf(__('Available placeholders: %s', 'woocommerce'), '<code>' . implode('</code>, <code>', array_keys($this->placeholders)) . '</code>');
      $this->form_fields = array(
        'enabled'            => array(
          'title'   => __('Enable/Disable', 'woocommerce'),
          'type'    => 'checkbox',
          'label'   => __('Enable this email notification', 'woocommerce'),
          'default' => 'yes',
        ),
        'recipient'          => array(
          'title'       => __('Recipient(s)', 'woocommerce'),
          'type'        => 'text',
          /* translators: %s: WP admin email */
          'description' => sprintf(__('Enter recipients (comma separated) for this email. Defaults to %s.', 'woocommerce'), '<code>' . esc_attr(get_option('admin_email')) . '</code>'),
          'placeholder' => '',
          'default'     => '',
          'desc_tip'    => true,
        ),
        'subject'            => array(
          'title'       => __('Subject', 'woocommerce'),
          'type'        => 'text',
          'desc_tip'    => true,
          'description' => $placeholder_text,
          'placeholder' => $this->get_default_subject(),
          'default'     => '',
        ),
        'heading'            => array(
          'title'       => __('Email heading', 'woocommerce'),
          'type'        => 'text',
          'desc_tip'    => true,
          'description' => $placeholder_text,
          'placeholder' => $this->get_default_heading(),
          'default'     => '',
        ),
        'additional_content' => array(
          'title'       => __('Additional content', 'woocommerce'),
          'description' => __('Text to appear below the main email content.', 'woocommerce') . ' ' . $placeholder_text,
          'css'         => 'width:400px; height: 75px;',
          'placeholder' => __('N/A', 'woocommerce'),
          'type'        => 'textarea',
          'default'     => $this->get_default_additional_content(),
          'desc_tip'    => true,
        ),
        'email_type'         => array(
          'title'       => __('Email type', 'woocommerce'),
          'type'        => 'select',
          'description' => __('Choose which format of email to send.', 'woocommerce'),
          'default'     => 'html',
          'class'       => 'email_type wc-enhanced-select',
          'options'     => $this->get_email_type_options(),
          'desc_tip'    => true,
        ),
      );
    }
  }

endif;

1. 在__construct()方法中定义邮件的ID、title、description等等。要想将email模板保存在自定义目录下，还要定义template_base，就是代码中的$this->template_base  = __DIR__ . '/emails/'。
2. $this->recipient必须是有效的邮件地址，或者逗号分隔的邮件列表。
3. trigger()函数负责判断是否发送邮件和实际发送邮件，该函数被触发的条件定义在__construct()函数中，例如add_action('woocommerce_order_status_pending_to_processing_notification', array($this, 'trigger'), 10, 2);，当订单状态从pending变成processing时看情况发送邮件。
4. get_content_html()和get_content_plain()负责获取邮件模板内容，因为模板的位置被修改了，所以这里也要告知模板位置，方法是向wc_get_template_html()函数传入额外参数。

创建邮件模板

邮件模板可以参考现有的邮件，这些文件位于woocommerce/templates/emails下，写一个简单的模板来测试，以下是my-custom-email.php的内容

<?php
// Exit if accessed directly
if (!defined('ABSPATH')) exit;

/*
 * @hooked WC_Emails::email_header() Output the email header
 */
do_action( 'woocommerce_email_header', $email_heading, $email ); ?>

<h2>这是一封自定义邮件</h2>

<?php
/*
 * @hooked WC_Emails::email_footer() Output the email footer
 */
do_action( 'woocommerce_email_footer', $email );

测试效果

首先，可以在WooCommerce > Settings >Emails下的邮件列表里找到”My Custom Email“，打开编辑界面，如下图所示，可以看到模板位置是位于插件下面的。

用WooCommerce付款测试插件下一个订单，并安装邮件log插件，例如Mail logging – WP Mail Catcher，查看下单后的邮件，可以找到我们的自定义邮件。

使邮件模板易于编辑

虽然可以通过邮件模板来编辑邮件，但还有更好的方式，比如所见即所得的page builder——yaymail。由于内容较长，感兴趣请移步Yaymail WooCommerce邮件模板生成器，支持自定义模版。