本教程详细阐述了如何在woocommerce中准确获取订单的客户备注。针对`wc_order::get_customer_note()`可能无法获取到客户作为评论提交的备注的问题，我们提供了一个定制化的数据库查询方案。通过直接查询`wp_comments`和`wp_commentmeta`表，您可以可靠地检索与特定订单关联的所有客户备注，并将其集成到如woocommerce bookings等插件的自定义显示中。
在WooCommerce开发中，有时我们需要获取客户在下单时或之后提供的特殊备注。虽然WooCommerce的WC_Order对象提供了一个get_customer_note()方法，但这个方法通常用于获取订单对象中直接存储的“客户备注”字段（通常是订单详情中的一个文本区域），而不是客户通过评论形式提交的、并被系统标记为“客户备注”的条目。当需要获取后者时，特别是当这些备注被其他插件（如WooCommerce Bookings）作为订单的附加信息处理时，直接使用get_customer_note()可能会导致无法获取到预期的内容。
理解WooCommerce中客户备注的存储机制
WooCommerce将许多类型的订单相关信息存储为评论（comments），并通过commentmeta表中的元数据来区分它们的类型。客户提交的备注，尤其是那些在特定场景下（例如在预订或特定产品配置中）被视为“备注”的，通常会被存储在{$wpdb->prefix}comments表中，并关联一个comment_post_ID（即订单ID），同时在{$wpdb->prefix}commentmeta表中会有一个meta_key为is_customer_note且meta_value为1的条目。
因此，要准确获取这些客户备注，我们需要直接查询数据库，根据订单ID和特定的元数据来筛选出这些评论。
定制化解决方案：通过数据库查询获取客户备注
为了克服WC_Order::get_customer_note()的局限性，我们可以编写一个自定义函数，通过WordPress的$wpdb全局对象直接查询数据库。以下是实现此功能的PHP代码：
/**
* 通过订单ID获取所有客户备注。
*
* @param int $order_id WooCommerce订单的ID。
* @return array 包含客户备注评论对象的数组，如果不存在则返回空数组。
*/
function cc_get_customer_notes($order_id) {
global $wpdb;
// 初始化一个空数组用于存储客户备注数据
$_customer_note_data = array();
// 构建SQL查询，从wp_comments和wp_commentmeta表中获取客户备注
$q = $wpdb->prepare(
"SELECT * FROM {$wpdb->comments}
WHERE comment_post_ID = %d
AND comment_ID IN (
SELECT comment_id FROM
{$wpdb->commentmeta}
WHERE meta_key = 'is_customer_note'
AND meta_value = 1
)",
$order_id
);
// 执行查询并获取结果
$_customer_note = $wpdb->get_results($q);
// 如果查询结果不为空，则将其赋值给返回数据
if (count($_customer_note) > 0) {
$_customer_note_data = $_customer_note;
}
return $_customer_note_data;
}
// 示例用法：
// 假设我们有一个订单ID，例如703
$order_id = 703;
$_customer_notes = cc_get_customer_notes($order_id);
echo "订单 #{$order_id} 的客户备注:
";
if (!empty($_customer_notes)) {
echo "- ";
foreach ($_customer_notes as $note) {
echo "
- 日期: " . esc_html($note->comment_date) . "
"; echo "备注内容: " . wp_kses_post($note->comment_content) . " ";
}
echo "
未找到该订单的客户备注。
"; }代码解析：
-
cc_get_customer_notes($order_id) 函数：
- 接受一个$order_id参数，这是我们想要查询的WooCommerce订单的ID。
- 使用global $wpdb;来访问WordPress的数据库抽象层。
-
SQL查询构建：
- SELECT * FROM {$wpdb->comments}：从wp_comments表中选择所有列。{$wpdb->comments}是获取wp_comments表名的标准方式，它会自动添加WordPress的表前缀。
- WHERE comment_post_ID = %d：将评论与特定的订单ID关联起来。%d是$wpdb->prepare()函数用于整数的安全占位符。
- AND comment_ID IN (...)：这是一个子查询，用于进一步过滤。它查找那些在wp_commentmeta表中具有meta_key为'is_customer_note'且meta_value为1的评论ID。
- $wpdb->prepare()：这是一个重要的安全函数，用于准备SQL查询。它通过将变量安全地插入到查询字符串中来防止SQL注入攻击。
- $wpdb->get_results($q)：执行构建好的SQL查询，并以对象数组的形式返回结果。每个对象代表一个评论（即一个客户备注）。
- 函数返回一个包含客户备注评论对象的数组。
集成与应用场景
这个cc_get_customer_notes函数可以在任何需要显示客户备注的地方使用，例如：
- WooCommerce Bookings插件的自定义模板：如果你正在修改预订订单的详情页面或邮件模板，你可以通过订单ID调用此函数来显示客户备注。
- 自定义订单管理页面：在WordPress后台的自定义订单详情页面中，你可以集成此函数来展示所有相关的客户备注。
- 报告或分析工具：用于生成包含客户备注的报告。
在这些场景中，你通常可以通过当前上下文获取到$order对象，然后使用$order->get_id()来获取$order_id。
示例：在WooCommerce Bookings的某个模板中显示备注
假设你在一个Bookings相关的模板文件（如single-booking.php或某个邮件模板）中，并且已经有了$booking对象。你可以从预订对象中获取关联的订单ID，然后调用我们的函数：
// 假设你已经获取到了 $booking 对象
$order_id = $booking->get_order_id(); // 获取预订关联的订单ID
if ($order_id) {
$_customer_notes = cc_get_customer_notes($order_id);
if (!empty($_customer_notes)) {
echo '';
echo '';
echo '';
echo '
';
}
}注意事项与最佳实践
- 代码位置：将cc_get_customer_notes函数放置在你的主题的functions.php文件、自定义插件中或一个mu-plugin中，以确保它在WordPress环境中全局可用。
- 安全性：始终使用$wpdb->prepare()来构建SQL查询，以防止SQL注入。在输出从数据库获取的内容时，使用esc_html()、wp_kses_post()或esc_textarea()等WordPress函数进行适当的清理和转义。
- 性能：直接查询数据库通常是高效的，但在循环中频繁调用此函数可能会影响性能。如果需要在多个地方显示相同订单的备注，可以考虑将结果缓存起来。
- 错误处理：在实际应用中，你可能需要添加更多的错误处理，例如检查$order_id是否有效。
- 与其他订单备注的区别：请注意，此函数专门用于获取被标记为is_customer_note=1的客户备注。WooCommerce订单还有其他类型的备注（如内部订单备注），它们可能没有这个元数据。如果你需要获取所有类型的订单备注，可以使用wc_get_order_notes()函数，但它返回的备注类型更广泛，需要进一步过滤。
总结
通过上述定制化的数据库查询方法，您可以可靠地从WooCommerce订单中获取客户提交的备注。这种方法绕过了WC_Order::get_customer_note()在处理作为评论存储的备注时的局限性，为开发者提供了更灵活和精确的数据访问能力，尤其适用于需要将这些备注集成到复杂插件（如WooCommerce Bookings）的显示逻辑中。遵循最佳实践，确保代码的安全性和效率，将有助于构建健壮的WooCommerce解决方案。
