本文档旨在指导开发者如何通过URL参数自定义WooCommerce产品查询，实现更灵活的产品筛选功能。我们将使用pre_get_posts action hook，该hook适用于商店和分类页面，允许我们根据URL参数动态修改产品查询条件，从而实现自定义的产品过滤。通过本文，你将学会如何在WooCommerce商店和分类页面中应用自定义meta query，根据URL参数筛选产品。
在WooCommerce项目中，经常需要根据URL参数对产品进行过滤，例如根据自定义字段的值进行筛选。虽然woocommerce_product_query action hook可以在主商店页面工作，但在分类页面可能无法生效。为了解决这个问题，我们可以使用pre_get_posts action hook，它能更可靠地修改产品查询，适用于包括商店和分类页面在内的多个场景。
使用pre_get_posts进行自定义查询
pre_get_posts action hook在WordPress执行主查询之前被触发，允许我们修改查询参数。以下代码展示了如何使用它来添加自定义的meta query，根据URL参数my_custom_key的值来筛选产品。
function custom_filter_products($query) {
// 确保只在主查询中修改产品查询
if( ! is_admin() && $query->is_main_query() && $query->get('post_type') == 'product') {
// 检查URL参数是否存在
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_filter_products' );代码解释:
- custom_filter_products($query) 函数: 这是我们自定义的函数，它接收WP_Query对象 $query 作为参数。
- ! is_admin(): 确保代码只在前台运行，避免影响后台管理界面。
- $query->is_main_query(): 检查是否是主查询，避免影响其他查询。
- $query->get('post_type') == 'product': 确认查询的是产品类型的文章。
- isset($_GET['my_custom_key']) && !empty($_GET['my_custom_key']): 检查URL参数 my_custom_key 是否存在且不为空。
- sanitize_text_field($_GET['my_custom_key']): 对URL参数进行安全处理，防止XSS攻击。
- $query->set( 'meta_query', $meta_query ): 设置 meta_query 参数，告诉WordPress根据自定义字段进行筛选。compare 设置为 '=' 表示精确匹配。
注意事项:
- 安全性: 务必对URL参数进行安全处理，防止SQL注入和XSS攻击。使用sanitize_text_field()函数可以有效地过滤用户输入。
- 性能: 如果需要添加多个meta query，建议一次性设置整个meta_query数组，而不是多次调用$query->set()。
- 优先级: pre_get_posts action hook的优先级默认为10，可以根据需要调整优先级，确保自定义的查询参数能够生效。例如，如果其他插件也在使用pre_get_posts，并且修改了查询参数，那么调整优先级可以确保你的代码能够按照预期工作。
示例:
假设你有一个自定义字段 product_color，你想根据URL参数 color 来筛选产品。你可以将上述代码中的 'my_custom_key' 替换为 'product_color'，并将 $_GET['my_custom_key'] 替换为 $_GET['color']。
例如，如果URL是 https://example.com/shop/?color=red，那么只有 product_color 字段值为 red 的产品才会显示在商店页面上。
总结:
使用pre_get_posts action hook可以有效地自定义WooCommerce产品查询，实现更灵活的产品筛选功能。通过添加自定义的meta query，可以根据URL参数或其他条件来筛选产品，从而提升用户体验。记住要对用户输入进行安全处理，并根据需要调整代码的优先级，以确保代码能够按照预期工作。
