WooCommerce扩展搜索支持自定义字段

学习知识要善于思考，思考，再思考！今天golang学习网小编就给大家带来《WooCommerce 扩展搜索支持自定义字段》，以下内容主要包含等知识点，如果你正在学习或准备学习文章，就都不要错过本文啦~让我们一起来看看吧，能帮助到你就更好了！

本教程详细介绍了如何在 WooCommerce 中为产品添加自定义数据字段，并进一步将这些自定义字段集成到产品搜索功能中。通过修改 WordPress 的核心搜索查询，我们将实现一个功能强大的解决方案，允许用户根据自定义数据字段来搜索产品，从而提升商店的搜索体验和灵活性。

1. 添加自定义产品数据字段

首先，我们需要在 WooCommerce 产品的通用数据部分添加一个自定义字段。这个字段将允许您为每个产品存储额外的信息，例如本例中的“Notch”。

以下代码演示了如何添加一个名为 _pdc_notch 的文本输入字段，并将其值保存到产品的元数据中。

/**
 * 在产品编辑页的“通用”选项卡中添加自定义字段
 */
add_action( 'woocommerce_product_options_general_product_data', 'woocommerce_product_options_general_product_data_action', 9999, 0 );
function woocommerce_product_options_general_product_data_action(): void {
    global $post;

    echo '<div class="options_group">';

    woocommerce_wp_text_input( [
        'id'            => '_pdc_notch',
        'wrapper_class' => '',
        'label'         => 'Notch',
        'desc_tip'      => true,
        'type'          => 'text',
        'description'   => '输入 Notch PDC',
        'value'         => get_post_meta( $post->ID, '_pdc_notch', true )
    ] );

    echo '</div>';
}

/**
 * 保存自定义字段的值
 *
 * @param int $product_id 当前产品的ID
 */
add_action( 'woocommerce_process_product_meta', 'woocommerce_process_product_meta_action', 10, 1 );
function woocommerce_process_product_meta_action( int $product_id ): void {
    // 确保字段存在并进行清理
    $pdc_notch = sanitize_text_field( wp_unslash( $_POST['_pdc_notch'] ?? null ) );

    // 更新或添加产品元数据
    update_post_meta( $product_id, '_pdc_notch', $pdc_notch );
}

将上述代码添加到您的子主题的 functions.php 文件中。完成此操作后，您将在编辑任何产品时，在“产品数据”部分的“通用”选项卡下看到一个新的“Notch”字段。

2. 扩展 WooCommerce 产品搜索功能

在添加并保存了自定义字段后，下一步是将其集成到 WooCommerce 的产品搜索功能中。直接使用 woocommerce_product_query 钩子来修改 WP_Query 的 meta_query 数组，在某些情况下可能无法完全满足需求，因为它可能不会像预期那样与主搜索字符串 (s) 进行逻辑“或”操作，导致搜索结果不完整或不准确。

为了确保自定义字段能够有效地与现有的产品搜索逻辑结合，我们需要更深入地修改 WordPress 的底层搜索查询。这里我们将使用 posts_search 过滤器，它允许我们直接操作生成的 SQL 搜索字符串。

/**
 * 扩展产品搜索，使其包含自定义字段的值
 *
 * @param string   $search 原始的 SQL 搜索字符串
 * @param WP_Query $query  当前的 WP_Query 对象
 * @return string 修改后的 SQL 搜索字符串
 */
add_filter( 'posts_search', 'filter_posts_search', 10, 2 );
function filter_posts_search( string $search, WP_Query $query ): string {
    global $wpdb;

    // 1. 验证条件：
    //    - 搜索字符串不为空
    //    - 存在搜索查询变量 's' 和 'post_type'
    //    - 搜索类型为 'product'
    //    - 不在后台管理页面
    //    - 是主查询且是搜索页面
    if ( empty( $search ) || ! ( isset( $query->query_vars['s'], $query->query_vars['post_type'] ) && ! empty( $query->query_vars['s'] ) && $query->query_vars['post_type'] === 'product' ) || is_admin() || ! is_search() || ! is_main_query() ) {
        return $search;
    }

    $product_ids = [];
    $search_term = esc_attr( $query->query_vars['s'] ); // 获取搜索词并进行转义

    // 2. 使用 wc_get_products 查找匹配自定义字段的产品
    //    这允许我们利用 WooCommerce 的 API 进行高效的元数据查询
    $products = wc_get_products( [
        'post_type'    => 'product',
        'limit'        => - 1, // 获取所有匹配的产品
        'meta_key'     => '_pdc_notch',
        'meta_value'   => $search_term,
        'meta_compare' => 'LIKE' // 使用 LIKE 运算符进行模糊匹配
    ] );

    /**
     * @var WC_Product $product
     */
    foreach ( $products as $product ) {
        $product_ids[] = $product->get_id();
    }

    // 确保产品ID唯一
    $product_ids = array_unique( $product_ids );

    // 3. 修改原始 SQL 搜索字符串
    //    如果找到了匹配自定义字段的产品，则将这些产品的 ID 添加到现有的搜索条件中
    //    通过 str_replace 将 "AND (((" 替换为 "AND (((products.ID IN (...)) OR ("
    //    这样，搜索结果将包含：
    //    (原始搜索条件) OR (自定义字段匹配的产品ID)
    if ( count( $product_ids ) > 0 ) {
        // 构建 ID 列表字符串
        $ids_string = implode( ',', $product_ids );
        // 查找并替换 SQL 字符串中的特定模式
        // 注意：这里的替换模式 'AND (((' 是基于 WordPress 生成的默认搜索查询结构
        $search = str_replace( "AND (((", "AND ((({$wpdb->posts}.ID IN ({$ids_string})) OR (", $search );
    }

    return $search;
}

代码解析：

1. 条件判断: 在修改搜索查询之前，我们进行了一系列严格的条件判断，确保只在以下情况执行：
   • 存在有效的搜索词。
   • 搜索类型为 product。
   • 当前不是后台管理页面。
   • 是前端的搜索页面且是主查询。
2. wc_get_products 查找: 我们利用 wc_get_products 函数，通过 meta_key 和 meta_value 参数来查询所有 _pdc_notch 字段值与用户搜索词匹配的产品。'meta_compare' => 'LIKE' 允许进行模糊匹配。
3. 修改 SQL 字符串: 这是核心部分。如果 wc_get_products 找到了任何匹配的产品，我们将这些产品的 ID 收集起来。然后，我们使用 str_replace 函数，在原始的 SQL 搜索字符串中找到一个特定的模式（通常是 AND (((，这是 WordPress 构建搜索查询的起始部分），并将其替换为：AND ((({$wpdb->posts}.ID IN ({$ids_string})) OR (。 这意味着，最终的 SQL 查询将变成：(原始搜索条件) OR (产品 ID 在自定义字段匹配列表中)。这有效地将自定义字段的搜索结果“或”到默认搜索结果中，确保任何通过自定义字段找到的产品都会被包含在内。

3. 注意事项与最佳实践

• 代码位置: 建议将所有代码片段放入您的子主题的 functions.php 文件中。这确保了在主题更新时您的自定义功能不会丢失。
• 性能考量: 对于拥有大量产品和自定义字段的网站，wc_get_products 的查询可能会对性能产生一定影响。如果您的网站规模庞大，可能需要考虑数据库索引优化或使用专门的搜索插件。
• 搜索词清理: 在将搜索词用于数据库查询之前，始终使用 sanitize_text_field() 和 esc_attr() 等函数进行清理和转义，以防止 SQL 注入和其他安全漏洞。
• 兼容性: WordPress 和 WooCommerce 的更新可能会改变其内部查询结构。如果未来出现问题，请检查 posts_search 过滤器中的 str_replace 模式是否仍然有效，并根据需要进行调整。
• 用户体验: 考虑在搜索结果页面上明确指出哪些结果是基于自定义字段匹配的，以提高用户的透明度。

通过遵循本教程，您将能够成功地在 WooCommerce 中扩展产品搜索功能，使其包含自定义产品数据字段，从而为您的客户提供更全面、更灵活的搜索体验。

好了，本文到此结束，带大家了解了《WooCommerce扩展搜索支持自定义字段》，希望本文对你有所帮助！关注golang学习网公众号，给大家分享更多文章知识！