本教程详细介绍了如何扩展woocommerce的产品搜索功能，使其能够检索自定义产品数据字段。文章首先展示了如何创建和保存一个名为“_pdc_notch”的自定义文本字段，随后通过分析默认搜索机制的局限性，提出并实现了一个基于wordpress `posts_search` 过滤器的解决方案。该方法通过修改sql查询，将匹配自定义字段的产品id注入到主搜索查询中，从而有效实现了自定义字段的搜索功能。
1. 概述与需求背景
在WooCommerce中，默认的产品搜索功能主要针对产品标题、描述和SKU等核心字段。然而，许多电商网站需要为产品添加自定义数据字段，并希望这些字段也能被用户搜索到。例如，可能有一个名为“Notch”的自定义属性，用于存储产品的特定型号或批次信息。本教程将指导您如何实现这一功能，让WooCommerce的搜索功能能够包含您自定义的产品数据字段。
2. 添加并保存自定义产品数据字段
首先，我们需要在WooCommerce产品的编辑页面中添加一个自定义字段，并确保其数据能够被正确保存。这里我们以一个名为 _pdc_notch 的文本字段为例。
2.1 添加自定义字段到产品编辑页面
使用 woocommerce_product_options_general_product_data 钩子，可以在产品编辑页面的“常规”选项卡中添加一个新的输入框。
add_action( 'woocommerce_product_options_general_product_data', 'woocommerce_product_options_general_product_data_action', 9999, 0 );
/**
* 在WooCommerce产品编辑页面的“常规”选项卡中添加自定义字段
*/
function woocommerce_product_options_general_product_data_action(): void {
global $post;
echo '<div class="options_group">';
woocommerce_wp_text_input( [
'id' => '_pdc_notch', // 自定义字段的ID
'wrapper_class' => '',
'label' => 'Notch', // 字段标签
'desc_tip' => true,
'type' => 'text',
'description' => '输入产品PDC Notch信息', // 字段描述
'value' => get_post_meta( $post->ID, '_pdc_notch', true ) // 获取并显示已保存的值
] );
echo '</div>';
}2.2 保存自定义字段数据
使用 woocommerce_process_product_meta 钩子，可以在产品保存时将自定义字段的值存储到数据库中。
add_action( 'woocommerce_process_product_meta', 'woocommerce_process_product_meta_action', 10, 1 );
/**
* 保存自定义产品数据字段
*
* @param int $product_id 当前产品的ID
*/
function woocommerce_process_product_meta_action( int $product_id ): void {
// 从POST请求中获取字段值，并进行安全清理
$pdc_notch = sanitize_text_field( wp_unslash( $_POST['_pdc_notch'] ?? null ) );
// 更新或添加产品元数据
update_post_meta( $product_id, '_pdc_notch', $pdc_notch );
}将以上代码片段添加到您的主题（或子主题）的 functions.php 文件中，或者通过自定义插件实现。完成这些步骤后，您就可以在WooCommerce产品编辑页面看到并保存“Notch”字段的值了。
3. 扩展WooCommerce产品搜索功能
在添加并保存自定义字段后，我们需要修改WooCommerce的搜索逻辑，使其能够查询 _pdc_notch 字段。直接使用 woocommerce_product_query 钩子添加 meta_query 在某些情况下可能无法完全生效，因为它主要影响 WP_Query 对象，但WordPress在构建SQL搜索语句时有其自身的处理逻辑。
一个更可靠的方法是利用WordPress的 posts_search 过滤器，它允许我们直接修改生成的SQL搜索查询字符串。
3.1 使用 posts_search 过滤器
posts_search 过滤器在WordPress生成SQL搜索查询的 WHERE 子句之后执行，这为我们提供了直接修改搜索逻辑的机会。
add_filter( 'posts_search', 'filter_posts_search_by_custom_field', 10, 2 );
/**
* 扩展产品搜索以使用自定义字段进行搜索
*
* @param string $search 原始的SQL搜索字符串
* @param WP_Query $query 当前的WP_Query对象
* @return string 修改后的SQL搜索字符串
*/
function filter_posts_search_by_custom_field( string $search, WP_Query $query ): string {
global $wpdb;
// 1. 验证条件：
// - 搜索字符串不为空
// - 存在搜索关键字 `s` 且不为空
// - 搜索类型为 `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() ||
! $query->is_main_query() ) {
return $search; // 不符合条件，返回原始搜索字符串
}
$product_ids = [];
$search_term = esc_attr( $query->query_vars['s'] ); // 获取并清理搜索关键词
// 2. 使用 wc_get_products 查找匹配自定义字段的产品
// - 'limit' => -1 获取所有匹配产品
// - 'meta_key' 和 'meta_value' 指定要搜索的自定义字段及其值
// - 'meta_compare' 可以是 'LIKE' (模糊匹配) 或 '=' (精确匹配)
$products = wc_get_products( [
'post_type' => 'product',
'limit' => -1,
'meta_key' => '_pdc_notch',
'meta_value' => $search_term,
'meta_compare' => 'LIKE' // 根据需求选择 'LIKE' 或 '='
] );
// 3. 收集所有匹配产品的ID
/** @var WC_Product $product */
foreach ( $products as $product ) {
$product_ids[] = $product->get_id();
}
$product_ids = array_unique( $product_ids ); // 去重
// 4. 如果找到了匹配自定义字段的产品，则修改原始SQL搜索字符串
if ( count( $product_ids ) > 0 ) {
// 构建一个SQL片段，用于检查产品ID是否在找到的ID列表中
$id_in_clause = "{$wpdb->posts}.ID IN (" . implode( ',', $product_ids ) . ")";
// 将此SQL片段注入到原始搜索查询的WHERE子句中
// 这里的替换逻辑是为了确保我们的自定义字段搜索条件与原有搜索条件以 OR 关系连接
// 原始搜索通常是 `AND (((...))`，我们将其修改为 `AND ((({$id_in_clause}) OR (...))`
$search = str_replace( 'AND (((', "AND (({$id_in_clause}) OR ((", $search );
}
return $search; // 返回修改后的搜索字符串
}3.2 代码解析
- 条件判断: 函数首先进行一系列严格的条件判断，确保只有在满足特定条件（如前端产品搜索、非空搜索词、主查询等）时才执行自定义搜索逻辑，避免不必要的性能开销或干扰其他查询。
- 获取匹配产品: 使用 wc_get_products 函数，通过 meta_key、meta_value 和 meta_compare 参数，高效地查询所有 _pdc_notch 字段值与用户搜索词匹配的产品。wc_get_products 是WooCommerce推荐的获取产品列表的方式，它性能良好且支持各种查询参数。
- 收集产品ID: 将所有匹配产品的ID收集到一个数组中，并进行去重。
- 修改SQL查询: 这是核心步骤。如果找到了匹配自定义字段的产品ID，我们构造一个SQL片段 {$wpdb->posts}.ID IN (...)。然后，使用 str_replace 将这个片段注入到原始的SQL搜索字符串中。注入的目的是将我们的自定义字段搜索结果与WordPress默认的搜索结果通过 OR 逻辑连接起来，即：如果产品ID在自定义字段匹配列表中，或者产品符合默认搜索条件，都应该被返回。
4. 部署与测试
- 将上述所有代码片段（添加字段和扩展搜索）添加到您的WordPress子主题的 functions.php 文件中。
- 在WooCommerce产品编辑页面，为您的产品添加一些“Notch”字段值。
- 访问您的商店前台，使用搜索框输入“Notch”字段中包含的关键词。
- 验证搜索结果是否包含那些在“Notch”自定义字段中匹配的产品。
5. 注意事项与总结
- 性能考量: 对于拥有海量产品（数十万级别）的网站，频繁地使用 wc_get_products 并在 posts_search 过滤器中进行数据库查询可能会对性能产生一定影响。在这种情况下，可以考虑使用专业的搜索插件（如Elasticsearch、Solr集成插件）来处理更复杂的搜索需求和优化性能。
- meta_compare 选择: 在 wc_get_products 查询中，meta_compare 参数可以设置为 'LIKE' 进行模糊匹配，或者 '=' 进行精确匹配。根据您的业务需求选择合适的比较方式。
- 代码位置: 建议将此类功能代码放置在子主题的 functions.php 文件中，或者创建一个独立的插件，以便于管理和更新。
- 可扩展性: 如果您有多个需要搜索的自定义字段，可以根据本教程的模式，在 filter_posts_search_by_custom_field 函数中添加额外的 wc_get_products 查询和 OR 条件，以包含更多字段的搜索结果。
通过本教程的方法，您已经成功地扩展了WooCommerce的产品搜索功能，使其能够有效地检索自定义产品数据字段，从而提升了用户体验和网站的实用性。
