在 WooCommerce 中通过数据库查询获取客户订单备注

本教程详细介绍了如何在 woocommerce 环境下，特别是在标准 `wc_order` 方法无法满足需求时，通过直接查询 wordpress 数据库来获取与特定订单关联的客户备注。我们将提供一个自定义 php 函数，通过查询 `wp_comments` 和 `wp_commentmeta` 表，准确检索那些被标记为客户备注的评论，确保您能够有效地访问和展示这些关键信息。

理解 WooCommerce 订单备注与挑战

在 WooCommerce 中，客户订单备注是商家理解客户特定需求或指示的重要信息。通常，WC_Order 对象提供了 get_customer_note() 方法来获取订单的客户备注。然而，在某些特定场景下，例如备注以评论形式存储并带有特定元数据（如 is_customer_note），或者当集成其他插件（如 WooCommerce Bookings）时，直接使用 get_customer_note() 可能无法检索到所有预期的客户备注。

一个常见的误区是尝试从 get_customer_note() 的返回值中获取 post_excerpt 属性，如下面的示例代码所示：

<p class="form-field form-field-wide">
    <label for="excerpt"><?php _e( 'Customer provided note', 'woocommerce-bookings' ); ?>:</label>
    <textarea rows="1" cols="40" name="excerpt" tabindex="6" id="excerpt" placeholder="<?php esc_attr_e( 'Customer notes about the order', 'woocommerce' ); ?>">
    <?php 
    // 这里的 $order->get_customer_note() 通常返回一个字符串，而非 WP_Post 对象
    $customer_note = $order->get_customer_note();
    // 尝试访问 $customer_note->post_excerpt 会导致错误或空值
    echo wp_kses_post( $customer_note->post_excerpt ); 
    ?></textarea>
</p>

这段代码的问题在于，$order->get_customer_note() 方法通常返回的是一个字符串（即客户备注的内容），而不是一个 WP_Post 对象。因此，尝试访问 $customer_note->post_excerpt 将会失败，导致无法获取到预期的备注内容。为了解决这类问题，当标准方法不适用时，直接查询数据库成为一个更可靠的方案。

通过数据库查询获取客户备注

为了确保能够准确获取到所有以评论形式存储并标记为客户备注的订单信息，我们可以直接查询 WordPress 数据库中的 wp_comments 和 wp_commentmeta 表。以下是一个自定义 PHP 函数，它通过订单 ID 来检索所有相关的客户备注：

知我AI·PC客户端

离线运行 AI 大模型，构建你的私有个人知识库，对话式提取文件知识，保证个人文件数据安全

0

查看详情

/**
 * 根据订单ID获取所有客户备注
 *
 * @param int $order_id 订单的ID。
 * @return array 包含客户备注数据的数组，如果不存在则为空数组。
 */
function cc_get_customer_notes($order_id) {
    global $wpdb; // 引入 WordPress 数据库对象

    $_customer_note_data = array(); // 初始化存储备注数据的数组

    // 构建 SQL 查询语句
    // 1. 从 wp_comments 表中选择所有字段
    // 2. 筛选 comment_post_ID 等于给定订单ID的评论
    // 3. 进一步筛选 comment_ID 在 wp_commentmeta 表中被标记为 'is_customer_note' = 1 的评论
    $query = "
        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
        )
    ";

    // 使用 $wpdb->prepare() 进行查询准备，提高安全性，防止SQL注入
    $_customer_notes = $wpdb->get_results( $wpdb->prepare( $query, $order_id ) );

    // 如果查询到结果，则将其赋值给返回数组
    if ( count( $_customer_notes ) > 0 ) {
        $_customer_note_data = $_customer_notes;
    }

    return $_customer_note_data; // 返回客户备注数据
}

函数解析

• global $wpdb;: 引入 WordPress 全局数据库对象，用于执行数据库操作。
• SQL 查询:
  • 外部查询 SELECT * FROM {$wpdb->prefix}comments WHERE comment_post_ID = %d: 这部分从 wp_comments 表中选择所有字段，并根据 comment_post_ID（即订单 ID）进行筛选。
  • 内部查询 SELECT comment_id FROM {$wpdb->prefix}commentmeta WHERE meta_key='is_customer_note' AND meta_value=1: 这部分查找所有在 wp_commentmeta 表中 meta_key 为 is_customer_note 且 meta_value 为 1 的评论 ID。这些评论 ID 代表了真正的客户备注。
  • AND comment_ID IN (...): 将外部查询的结果限制为只包含内部查询返回的评论 ID，确保只获取到客户备注。
• $wpdb->prepare( $query, $order_id ): 这是 WordPress 推荐的数据库查询安全实践。它通过将变量（$order_id）安全地插入到 SQL 查询中来防止 SQL 注入攻击。%d 是一个占位符，表示将插入一个整数。
• $wpdb->get_results(...): 执行查询并返回一个对象数组，每个对象代表一个客户备注（评论）。
• 返回值: 如果找到客户备注，函数返回一个包含这些备注对象的数组；否则返回一个空数组。

如何使用此函数

要使用 cc_get_customer_notes 函数，您只需提供订单的 ID。以下是一个简单的示例：

// 假设您已经获取到订单ID，例如从 URL 参数或订单对象中
$order_id = 703; // 替换为您的实际订单ID

// 调用自定义函数获取客户备注
$_customer_notes = cc_get_customer_notes($order_id);

echo "<h2>客户订单备注 (订单ID: {$order_id})</h2>";

if ( ! empty( $_customer_notes ) ) {
    echo "<ul>";
    foreach ( $_customer_notes as $note ) {
        // 每个 $note 对象包含评论的所有字段，如 comment_content, comment_date 等
        echo "<li><strong>日期:</strong> " . esc_html( $note->comment_date ) . "<br>";
        echo "<strong>备注内容:</strong> " . wp_kses_post( $note->comment_content ) . "</li>";
    }
    echo "</ul>";
} else {
    echo "<p>未找到该订单的客户备注。</p>";
}

在上述示例中，我们首先定义了一个 $order_id，然后调用 cc_get_customer_notes 函数。如果函数返回了备注，我们将遍历这些备注并显示其日期和内容。wp_kses_post() 用于安全地输出评论内容，防止恶意脚本注入。

注意事项与最佳实践

1. 安全性 ($wpdb->prepare()): 始终使用 $wpdb->prepare() 来处理包含变量的 SQL 查询。这对于防止 SQL 注入至关重要。本教程中的示例已遵循此最佳实践。
2. 性能: 对于高流量网站或需要频繁查询的场景，可以考虑对查询结果进行缓存，以减少数据库负载。WordPress 提供了 Transients API 或对象缓存机制来实现这一点。
3. 错误处理: 在实际应用中，您可能需要添加更健壮的错误处理机制，例如检查 $order_id 是否为有效的整数，以及查询是否成功。
4. 替代方案: 对于某些类型的订单备注（例如由管理员添加的订单备注或状态变更备注），wc_get_order_notes() 函数可能更适用。但是，对于本教程中讨论的特定客户备注（通过 is_customer_note 元数据标记），直接数据库查询是目前最可靠的方法。
5. 代码位置: 将 cc_get_customer_notes 函数放置在主题的 functions.php 文件中，或者更推荐地，放置在一个自定义插件中，以确保在主题切换时代码不会丢失。

总结

当标准的 WooCommerce 方法无法满足获取特定客户订单备注的需求时，直接通过数据库查询 wp_comments 和 wp_commentmeta 表提供了一个强大而灵活的解决方案。通过本文提供的 cc_get_customer_notes 函数，您可以准确地检索并展示这些关键的客户信息，从而增强您的 WooCommerce 商店的功能性和用户体验。遵循安全和性能最佳实践，确保您的实现既高效又可靠。

以上就是在 WooCommerce 中通过数据库查询获取客户订单备注的详细内容，更多请关注php中文网其它相关文章！