本教程详细阐述了在WooCommerce中通过自定义数据库查询来准确获取订单客户备注的方法。针对标准函数可能无法满足特定集成需求（如与WooCommerce Bookings插件结合）的问题，文章提供了一个基于`wpdb`的解决方案，解释了客户备注在数据库中的存储机制，并指导如何编写函数来检索、处理和显示这些备注，确保在自定义场景下信息的完整性与准确性。
引言：WooCommerce客户备注的挑战
在WooCommerce中，客户备注是订单处理流程中的重要信息，它们允许客户在下单时提供额外的指示或偏好。通常，我们可以通过WC_Order对象的相关方法来访问这些备注。然而，在某些特定的自定义开发场景下，例如将客户备注集成到第三方插件（如WooCommerce Bookings）的自定义界面中，或需要以特定格式检索所有历史备注时，直接使用标准方法可能无法按预期工作，或者返回的数据格式不符合需求。这通常是因为对WooCommerce底层数据存储机制的理解不足，或者标准方法仅返回特定类型的备注。当遇到这种情况时，深入数据库层面进行自定义查询便成为一种强大且灵活的解决方案。
WooCommerce客户备注的存储机制解析
要有效地自定义检索客户备注，首先需要理解WooCommerce是如何存储这些信息的。在WordPress和WooCommerce的架构中，客户备注并非独立存储在一个专门的表中，而是巧妙地利用了WordPress的评论（Comments）系统。
具体来说：
- 存储位置：客户备注被存储在WordPress的{$wpdb->prefix}comments表中。
- 关联订单：每个客户备注通过comment_post_ID字段与相应的WooCommerce订单（该订单在{$wpdb->prefix}posts表中以shop_order类型存在）关联。
- 身份标识：为了区分普通的评论和客户备注，WooCommerce在{$wpdb->prefix}commentmeta表中为客户备注添加了一个特定的元数据：meta_key为is_customer_note，meta_value为1。
了解这一机制是编写精准自定义查询的关键。
自定义函数：精准检索订单客户备注
基于上述存储机制，我们可以编写一个自定义PHP函数，利用WordPress的wpdb对象直接查询数据库，以获取指定订单的所有客户备注。
prepare(
"SELECT * FROM {$wpdb->prefix}comments
WHERE comment_post_ID = %d
AND comment_ID IN (
SELECT comment_id FROM {$wpdb->prefix}commentmeta
WHERE meta_key = 'is_customer_note'
AND meta_value = 1
)
ORDER BY comment_date_gmt ASC", // 通常按时间升序排列
$order_id
);
$_customer_notes = $wpdb->get_results( $query );
return $_customer_notes;
}
?>代码解析：
- global $wpdb;: 引入WordPress的数据库操作对象。
- $order_id = absint( $order_id );: 对输入的订单ID进行安全处理，确保其为无符号整数，有效防止SQL注入风险。
- $wpdb->prepare(...): 使用prepare方法构建SQL查询，这是WordPress推荐的安全实践，它会自动转义参数。
- SELECT * FROM {$wpdb->prefix}comments: 从评论表中选择所有字段。
- WHERE comment_post_ID = %d: 筛选出与特定订单ID关联的评论。%d是prepare方法用于整数的占位符。
- AND comment_ID IN (...): 这是一个子查询，用于进一步筛选出那些被标记为客户备注的评论。
- SELECT comment_id FROM {$wpdb->prefix}commentmeta WHERE meta_key = 'is_customer_note' AND meta_value = 1: 子查询从commentmeta表中查找所有is_customer_note元键值为1的评论ID。
- ORDER BY comment_date_gmt ASC: 按照备注的创建时间（GMT）升序排列，这样可以按时间顺序获取备注。
- $wpdb->get_results( $query );: 执行SQL查询并返回一个包含结果对象的数组。每个对象代表一个客户备注，其属性对应comments表中的字段（例如comment_content、comment_date等）。
实际应用：获取与显示客户备注
一旦cc_get_customer_notes函数定义完成（建议将其放置在主题的functions.php文件或自定义插件中），就可以在任何需要的地方调用它来获取客户备注数据。
以下示例展示了如何在自定义表单或显示区域中，将获取到的客户备注填充到一个文本区域（textarea）中，这尤其适用于如WooCommerce Bookings插件的自定义订单编辑界面。
get_id(); // 获取订单ID
$_customer_notes = cc_get_customer_notes( $order_id ); // 调用自定义函数获取备注
// 原始问题代码尝试使用 $customer_note->post_excerpt，这是不正确的。
// 正确的备注内容字段是 WP_Comment 对象中的 comment_content。
// 如果有多个备注，我们通常需要将它们连接起来显示在一个 textarea 中。
$display_notes_content = '';
if ( ! empty( $_customer_notes ) ) {
$all_notes_array = array();
foreach ( $_customer_notes as $note ) {
// 确保备注内容是字符串，并进行清理
$all_notes_array[] = wp_kses_post( $note->comment_content );
}
// 将所有备注用双换行符连接起来，以便在 textarea 中清晰显示
$display_notes_content = implode( "\n\n", $all_notes_array );
} else {
$display_notes_content = __( 'No customer notes found for this order.', 'woocommerce-bookings' );
}
?>
' . __( 'Order not found or invalid.', 'woocommerce-bookings' ) . '';
}
?>关键优化点：
- comment_content：明确指出备注内容存储在返回对象的comment_content属性中，而非post_excerpt。
- 多条备注处理：如果一个订单有多个客户备注，上述代码会将所有备注内容通过双换行符连接起来，然后显示在一个textarea中，确保所有信息都可见。
- esc_textarea()：在输出到textarea时，使用esc_textarea()函数进行转义，这是防止XSS攻击和确保内容正确显示的最佳实践。
- readonly属性：通常在显示客户备注时，我们不希望用户直接编辑，因此添加readonly属性是合适的。
注意事项与最佳实践
- 安全性：始终使用$wpdb->prepare()方法来构建SQL查询，并对输入参数进行适当的清理（如absint()），以防止SQL注入攻击。
- 性能考虑：对于拥有大量订单和备注的网站，直接进行数据库查询可能会对性能产生轻微影响。在极端情况下，可以考虑缓存查询结果。然而，对于大多数WooCommerce网站，这种查询的性能影响通常可以忽略不计。
- 数据处理：cc_get_customer_notes函数返回的是一个WP_Comment对象数组。在显示或使用这些数据时，需要根据实际需求提取相应的字段（如comment_content、comment_date等），并进行适当的格式化。
- 多条备注：如果一个订单有多个客户备注，您需要决定如何处理它们：是显示所有备注、只显示最新一条、还是将它们合并。上述示例展示了如何合并所有备注。
- 替代方案：WooCommerce自身也提供了wc_get_order_notes()函数来获取订单备注，它可以根据类型（如customer）过滤。然而，如果遇到wc_get_order_notes()无法满足的特定需求（例如，需要更底层的控制或与特定插件的集成问题），自定义wpdb查询仍然是不可或缺的强大工具。
总结
通过深入理解WooCommerce客户备注的底层存储机制，并结合wpdb进行自定义数据库查询，开发者可以灵活、精准地获取和处理订单客户备注数据。这种方法不仅解决了标准函数可能无法满足的特定集成需求，也为WooCommerce的深度定制和功能扩展提供了坚实的基础。掌握这种自定义查询技术，将使您在开发复杂的WooCommerce解决方案时更加得心应手。
