如何在 WooCommerce 邮件模板钩子中安全获取订单 ID

3次阅读

如何在 WooCommerce 邮件模板钩子中安全获取订单 ID

本文详解在 woocommerce_email_before_order_table 等邮件钩子中正确获取 WooCommerce 订单 ID 的方法,解决因参数传递不一致导致的 $order->get_id() 失效或 PHP 致命错误问题,并提供健壮的兼容性写法与调试建议。

本文详解在 `woocommerce_email_before_order_table` 等邮件钩子中正确获取 woocommerce 订单 id 的方法,解决因参数传递不一致导致的 `$order->get_id()` 失效或 php 致命错误问题,并提供健壮的兼容性写法与调试建议。

在 WooCommerce 邮件系统中,不同版本(尤其是 3.0+)对 woocommerce_email_before_order_table 等钩子的参数传递方式存在细微但关键的差异:该钩子实际接收的第一个参数并非始终是 WC_Order 对象实例,而可能是订单 ID(整型)或已实例化的对象,具体取决于调用上下文和 WooCommerce 版本。这正是你遇到“硬编码 ID 可用,但 $order->get_id() 报错或返回空”的根本原因——代码假设了 $order 恒为对象,但实际可能为 int 或未完全初始化的对象。

正确的做法是统一通过 wc_get_order() 进行标准化实例化,确保无论传入的是 ID、对象还是其他兼容类型,都能获得一个可安全调用方法的 WC_Order 实例:

add_action( 'woocommerce_email_before_order_table', function ( $order, $sent_to_admin, $plain_text, $email ) {     // ✅ 安全获取 WC_Order 实例(兼容 ID 或对象输入)     $order = wc_get_order( $order );      // ❌ 错误示例:直接假设 $order 是对象并调用方法(可能报错)     // echo FS4E_VSDC::fs4e_get_order_slip( $order->get_id() );      // ✅ 推荐:先校验实例有效性,再获取 ID     if ( ! $order || ! is_a( $order, 'WC_Order' ) ) {         Error_log( '[WooCommerce Email Hook] Invalid order Object received.' );         return;     }      $order_id = $order->get_id();     $slip_html = FS4E_VSDC::fs4e_get_order_slip( $order_id );      // 输出前建议检查返回值,避免空内容破坏邮件结构     if ( ! empty( $slip_html ) ) {         echo wp_kses_post( $slip_html ); // 使用 wp_kses_post 防止 XSS(尤其当 slip 含 HTML 时)     } }, 10, 4 );

⚠️ 关键注意事项

  • 不要直接访问 $order[‘order_id’]:WC_Order 是对象而非数组,$order[order_id] 会触发 Fatal Error: Cannot use object of type WC_Order as Array(如你所见)。
  • 避免使用 $order->id(已废弃):WooCommerce 3.0+ 已弃用直接访问 ->id 属性,必须使用 ->get_id() 方法。
  • 钩子参数数量必须匹配:woocommerce_email_before_order_table 明确接收 4 个参数($order, $sent_to_admin, $plain_text, $email),因此 add_action() 的第 4 个参数($accepted_args)必须为 4,否则 $sent_to_admin 等后续参数将无法正确传入。
  • 启用日志调试:在生产环境前,建议临时添加 error_log( print_r( gettype($order) . ‘ | ‘ . ( is_object($order) ? $order->get_id() : $order ), true ) ); 快速确认传入类型。

此外,若你的 fs4e_get_order_slip() 方法依赖订单状态或支付信息,请确保在邮件触发时这些数据已持久化(例如:customer_processing_order 邮件中订单状态为 wc-processing,但 customer_completed_order 中才为 wc-completed)。必要时可在钩子内补充状态判断:

if ( 'wc-completed' === $order->get_status() ) {     echo wp_kses_post( FS4E_VSDC::fs4e_get_order_slip( $order_id ) ); }

综上,以 wc_get_order() 为中心进行类型安全转换,配合显式对象校验与参数完整性保障,是稳定获取订单 ID 并集成第三方服务(如电子发票、物流单)到 WooCommerce 邮件中的最佳实践

text=ZqhQzanResources