在 woocommerce 商店开发中，经常需要根据 url 参数实现自定义的产品筛选功能。通常，开发者会使用 woocommerce_product_query 钩子来修改产品查询，以添加自定义的 meta_query。然而，这种方法在主商店页面工作正常，但在产品分类页面却可能失效。这是因为在产品分类页面，查询的构建方式可能不同，导致 woocommerce_product_query 钩子无法正确地修改查询。
为了解决这个问题，可以使用 pre_get_posts 钩子。pre_get_posts 钩子允许开发者在 WordPress 执行查询之前修改查询对象。通过检查查询对象，可以确定当前是否是主查询，以及查询的帖子类型是否为产品。如果是，就可以添加自定义的 meta_query。
以下是一个使用 pre_get_posts 钩子来实现自定义产品筛选功能的示例代码：
function custom_product_filter( $query ) {
if ( ! is_admin() && $query->is_main_query() && $query->get( 'post_type' ) == 'product' ) {
// 检查是否存在 'my_custom_key' GET 参数
if ( isset( $_GET['my_custom_key'] ) && !empty($_GET['my_custom_key']) ) {
$meta_query = array(
array(
'key' => 'my_custom_key',
'value' => sanitize_text_field($_GET['my_custom_key']), // 对输入进行安全处理
'compare' => '=',
),
);
$query->set( 'meta_query', $meta_query );
}
}
}
add_action( 'pre_get_posts', 'custom_product_filter' );代码解释：
- custom_product_filter( $query ) 函数： 这是自定义的函数，用于修改查询对象。
- ! is_admin()： 确保代码只在前台执行，避免影响后台管理界面。
- $query->is_main_query()： 检查当前查询是否是主查询。这很重要，因为我们只想修改主查询，而不是其他辅助查询。
- $query->get( 'post_type' ) == 'product'： 检查查询的帖子类型是否为产品。
- isset( $_GET['my_custom_key'] )： 检查是否存在名为 my_custom_key 的 GET 参数。
- sanitize_text_field($_GET['my_custom_key'])： 对 GET 参数进行安全清理，防止 XSS 攻击。 这是非常重要的安全措施。
-
$meta_query 数组： 定义要添加的 meta_query。
- 'key'：要查询的自定义字段的键名。
- 'value'：要匹配的值，从 GET 参数中获取。
- 'compare'：比较运算符，这里使用 = 表示精确匹配。
- $query->set( 'meta_query', $meta_query )： 将 meta_query 添加到查询对象中。
- add_action( 'pre_get_posts', 'custom_product_filter' )： 将自定义函数添加到 pre_get_posts 钩子。
注意事项：
- 安全性： 始终对用户输入进行安全清理，防止 XSS 和 SQL 注入攻击。sanitize_text_field() 函数可以用来清理文本类型的输入。
- 性能： 过度使用 meta_query 可能会影响查询性能。如果需要进行复杂的筛选，可以考虑使用自定义的数据库查询或使用专业的 WooCommerce 筛选插件。
- 调试： 可以使用 var_dump( $query ) 或 print_r( $query ) 来调试查询对象，查看是否正确地添加了 meta_query。
- 参数验证: 确保对GET参数进行验证，例如，如果my_custom_key应该是数字，请使用is_numeric()函数进行验证。
总结：
通过使用 pre_get_posts 钩子，可以有效地解决 WooCommerce 产品分类页面筛选失效的问题。这种方法可以在主查询中设置 meta_query，从而实现在主商店页面和产品分类页面都能正常工作的自定义筛选功能。同时，需要注意安全性和性能问题，并对用户输入进行适当的清理和验证。
