理解WooCommerce邮件系统与附件机制
在woocommerce中发送自定义邮件并附加文件，需要对woocommerce的邮件系统有深入的理解。核心在于正确实例化邮件发送器（mailer）对象，并以正确的方式构建邮件内容和附件路径。常见的错误包括使用过时的方法获取mailer实例、不正确的附件文件路径，以及对邮件发送函数参数的误用。
正确的Mailer实例化与邮件发送
WooCommerce推荐使用WC()->mailer()来获取邮件发送器实例，而不是依赖全局变量$woocommerce。这确保了与最新WooCommerce版本的兼容性和代码的健壮性。
以下是构建和发送带有附件的自定义邮件的步骤：
- 选择合适的钩子： 根据您的需求选择合适的WooCommerce动作钩子。例如，当订单状态改变时发送邮件，可以使用woocommerce_order_status_changed。此钩子提供了$order_id, $old_status, $new_status, $order等参数，非常适合根据订单状态进行逻辑判断。
- 获取Mailer实例： 使用WC()->mailer()获取WooCommerce的邮件发送器实例。
- 准备邮件内容： 定义收件人、主题、邮件正文以及邮件头（如Content-Type）。
- 指定附件路径： 附件路径必须是服务器上的绝对路径。通常，PDF或其他文件会存储在wp-content目录下。WP_CONTENT_DIR常量可以帮助您构建正确的绝对路径。
- 调用send()方法： 使用Mailer实例的send()方法发送邮件，并确保传递所有必要的参数，包括附件数组。
示例代码：在订单完成时发送带附件的邮件
以下是一个修正后的代码示例，演示如何在订单状态变为“已完成”（completed）且支付方式为“dobirka”时，向客户发送一封带有PDF附件的自定义邮件。
/**
* 在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_gift_email( $order_id, $old_status, $new_status, $order ) {
// 检查订单新状态是否为“已完成”且支付方式为“dobirka”
if ( 'completed' === $new_status && 'dobirka' === $order->get_payment_method() ) {
// 获取WooCommerce邮件发送器实例
$mailer = WC()->mailer();
// 定义邮件接收者、主题和消息体
$to = $order->get_billing_email();
$subject = sprintf( __( '您的订单 #%s 附带惊喜礼物！', 'your-text-domain' ), $order->get_order_number() );
$message_body = sprintf(
__( '亲爱的 %s,
感谢您在我们的商店购物！您的订单 #%s 已完成，我们为您准备了一份小礼物，请查收附件中的PDF文件。
祝您购物愉快！', 'your-text-domain' ),
$order->get_billing_first_name(),
$order->get_order_number()
);
// 包装邮件消息，添加邮件头（如“亲爱的 [客户名]”）
// 注意：这里的wrap_message的第一个参数通常是邮件的标题或头部，
// 第二个参数是邮件正文。这里我们直接将欢迎语包含在message_body中，
// 头部可以是一个通用标题。
$message = $mailer->wrap_message(
sprintf( __( '订单 #%s 已完成', 'your-text-domain' ), $order->get_order_number() ),
$message_body
);
// 定义邮件头，声明邮件内容为HTML格式
$headers = 'Content-Type: text/html; charset=UTF-8' . "\r\n";
// 定义附件路径数组
// 请确保 '/file.pdf' 是您实际文件在wp-content目录下的相对路径
$attachments = array( WP_CONTENT_DIR . '/file.pdf' );
// 发送邮件
// 参数顺序：收件人、主题、消息、邮件头、附件
$mailer->send( $to, $subject, $message, $headers, $attachments );
}
}
add_action( 'woocommerce_order_status_changed', 'custom_woocommerce_order_status_changed_send_gift_email', 10, 4 );
注意事项与最佳实践
-
附件文件路径：
- 务必使用文件的绝对路径。WP_CONTENT_DIR常量指向WordPress的wp-content目录的绝对路径，是构建附件路径的常用且安全的方式。
- 例如，如果您的PDF文件位于wp-content/uploads/2023/10/gift.pdf，则路径应为WP_CONTENT_DIR . '/uploads/2023/10/gift.pdf'。
- 在部署前，请确保文件确实存在于指定路径，否则邮件将无法附加该文件。
- WC()->mailer()： 这是获取WooCommerce邮件发送器实例的推荐方式，替代了旧的global $woocommerce; $woocommerce->mailer();用法，更符合现代WordPress和WooCommerce的开发规范。
- 钩子参数： woocommerce_order_status_changed钩子在WordPress 3.0+版本中，其回调函数接受4个参数：$order_id, $old_status, $new_status, $order。因此，add_action的最后一个参数必须是4，表示您的回调函数将接受这4个参数。
- 文本域（Text Domain）： 在__('...', 'your-text-domain')中使用您的插件或主题的文本域，以便于国际化和翻译。
- 代码放置位置： 建议将此类自定义代码放置在子主题的functions.php文件中，或者创建一个自定义插件来管理这些功能，以避免在主题更新时丢失更改。
- 调试： 如果邮件没有发送或附件没有出现，请检查您的WordPress错误日志。您也可以暂时将WP_DEBUG设置为true并在wp-config.php中开启WP_DEBUG_LOG来记录错误信息。
总结
在WooCommerce中为自定义邮件添加附件是一个常见的需求。通过正确理解和使用WC()->mailer()实例、构建正确的附件绝对路径，并利用合适的动作钩子，开发者可以轻松实现这一功能。遵循上述指南和最佳实践，将确保您的自定义邮件系统稳定、高效且功能完善。
