深入解析：在WooCommerce自定义邮件中添加附件-小浪学习网

深入解析：在WooCommerce自定义邮件中添加附件

本文旨在提供一份详细的教程，指导开发者如何在WooCommerce的自定义邮件中正确地添加附件。我们将探讨常见的错误、使用现代化的WooCommerce邮件API，并提供一个基于订单状态变化的完整代码示例，确保附件能够成功发送给客户。

1. 理解WooCommerce邮件系统与附件机制

WooCommerce提供了一个强大的邮件系统，允许开发者发送各种通知邮件。当我们需要在自定义邮件中包含附件时，关键在于正确地实例化邮件发送器（Mailer）并提供附件的绝对路径。常见的错误包括使用过时的方法、不正确的附件路径或遗漏必要的邮件头部信息。

2. 正确添加附件到自定义邮件

为了在WooCommerce自定义邮件中添加附件，我们需要遵循以下步骤：

选择合适的钩子： 根据触发邮件发送的事件，选择一个合适的WordPress或WooCommerce动作钩子。例如，当订单状态发生变化时，可以使用woocommerce_order_status_changed。
获取邮件发送器实例： 使用WC()->mailer()获取WooCommerce邮件发送器的实例，这是推荐的现代化方法。
准备邮件内容和参数： 包括收件人、主题、邮件正文、以及必要的邮件头部。
指定附件路径： 附件路径必须是服务器上的绝对路径。WP_CONTENT_DIR是一个非常有用的常量，它指向WordPress的wp-content目录，可以帮助我们构建正确的绝对路径。
调用send()方法发送邮件： send()方法接受多个参数，包括收件人、主题、邮件内容、邮件头部和附件数组。

下面是一个完整的代码示例，演示了如何在订单状态变为“已完成”且支付方式为“dobirka”时，向客户发送一封带附件的自定义邮件：

/**  * 在WooCommerce订单状态改变时发送带附件的自定义邮件。  *  * @param int      $order_id   订单ID。  * @param string   $old_status 订单旧状态。  * @param string   $new_status 订单新状态。  * @param WC_Order $order      WC_Order 对象。  */ function custom_woocommerce_order_status_changed_send_email_with_attachment( $order_id, $old_status, $new_status, $order ) {     // 检查订单状态是否变为 'completed' 且支付方式为 'dobirka'     if ( 'completed' === $new_status && 'dobirka' === $order->get_payment_method() ) {         // 获取 WooCommerce 邮件发送器实例         $mailer = WC()->mailer();          // 邮件收件人：订单的账单邮箱         $to = $order->get_billing_email();          // 邮件主题         $subject = sprintf( __( '您的订单 #%s 附带礼品', 'woocommerce' ), $order->get_order_number() );          // 邮件正文         $message_body = sprintf(              __( '亲爱的 %s，您的订单 #%s 已完成。感谢您的购买，随信附上我们为您准备的惊喜礼品。', 'woocommerce' ),              $order->get_billing_first_name(),             $order->get_order_number()         );          // 邮件头部（包含主题行）         // wrap_message 方法用于将邮件内容包装成标准的 WooCommerce 邮件模板格式         $message = $mailer->wrap_message(              sprintf( __( '订单 #%s 已完成', 'woocommerce' ), $order->get_order_number() ),              $message_body          );          // 邮件头部信息，指定内容类型为 html         $headers = 'Content-Type: text/html; charset=UTF-8' . "rn";          // 附件的绝对路径。请确保 'your-gift-file.pdf' 存在于 wp-content 目录下         // 替换 'your-gift-file.pdf' 为你的实际文件名         $attachments = Array( WP_CONTENT_DIR . '/your-gift-file.pdf' );           // 发送邮件         $mailer->send( $to, $subject, $message, $headers, $attachments );     } } // 注册钩子，优先级为 10，接受 4 个参数 add_action( 'woocommerce_order_status_changed', 'custom_woocommerce_order_status_changed_send_email_with_attachment', 10, 4 );

3. 代码解析与注意事项

add_action( ‘woocommerce_order_status_changed’, ‘…’, 10, 4 );: 这个钩子会在任何订单状态改变时触发。10是优先级，4表示回调函数接受4个参数：$order_id, $old_status, $new_status, $order。直接使用$order对象比通过new WC_Order($order_id)更高效。
WC()->mailer();: 这是获取WooCommerce邮件发送器实例的推荐方式，替代了旧的global $woocommerce; $woocommerce->mailer();。
$order->get_payment_method(): 用于获取订单的支付方式。
$mailer->wrap_message(): 此方法用于将您的邮件内容包装到WooCommerce的默认邮件模板中，确保邮件外观与WooCommerce其他邮件保持一致。第一个参数是邮件的“头部”或“标题行”，第二个参数是邮件正文。
$headers = ‘Content-Type: text/html; charset=UTF-8’ . “rn”;: 这是非常重要的一行，它告诉邮件客户端邮件内容是HTML格式，并且使用UTF-8编码。如果缺少或错误，邮件内容可能会显示为纯文本或乱码。
$attachments = array( WP_CONTENT_DIR . ‘/your-gift-file.pdf’ );:
- WP_CONTENT_DIR: 这是一个WordPress常量，指向wp-content目录的服务器绝对路径。使用它来构建附件路径可以增强代码的可移植性，因为您不需要硬编码完整的服务器路径。
- 文件路径准确性: 确保’/your-gift-file.pdf’是附件在wp-content目录下的实际文件名和路径。如果文件在子目录中（例如wp-content/uploads/gifts/my-gift.pdf），则路径应为WP_CONTENT_DIR . ‘/uploads/gifts/my-gift.pdf’。
- 文件权限: 确保附件文件在服务器上具有正确的读取权限，否则php可能无法访问该文件。
$mailer->send( $to, $subject, $message, $headers, $attachments );: 这是发送邮件的核心方法。请注意参数的顺序：收件人、主题、邮件内容（已包装）、邮件头部、附件数组。