自定义WooCommerce产品状态致搜索无法排除缺货商品的求助

问题背景 #

• 给WooCommerce产品添加了自定义状态（代码如下），虽然设置了exclude_from_search => true但没效果，导致WooCommerce原生的「从目录中隐藏缺货商品」功能失效，缺货商品依然出现在搜索结果里。
• 尝试用pre_get_posts钩子过滤搜索结果，能排除缺货商品，但同时把文章、页面等非产品类内容也屏蔽了。

自定义产品状态代码 #

add_action( 'init', 'my_custom_status_creation' );
function my_custom_status_creation(){

    $status_keys   = array(
            'retired'=>'Retired',
            'sold-ooaks'=>'Sold OOAKs',
            'consignment'=>'Sent to Consignment',
            'pickbox'=>'Out on Pickbox'
        );

        foreach ($status_keys as $status_key=>$label){

            $status_label = _x( $label, 'post', 'woocommerce' );

            register_post_status( $status_key, array(
            'label'                     => $status_label,
            'public'                    => true,
            'exclude_from_search'       => true,
            'show_in_admin_all_list'    => true,
            'show_in_admin_status_list' => true,
            'label_count'               => _n_noop( $status_label.' <span class="count">(%s)</span>', $status_label.' <span class="count">(%s)</span>'),
        ) );
        }
}

尝试过的有缺陷的搜索过滤代码 #

add_action( 'pre_get_posts', 'misha_hide_out_of_stock_in_search' );

function misha_hide_out_of_stock_in_search( $query ) {

    if( $query->is_search() && $query->is_main_query() ) {
        $query->set( 'meta_key', '_stock_status' );
        $query->set( 'meta_value', 'instock' );
    } 
}

解决方案 #

修改pre_get_posts的回调函数，只对product类型的内容应用库存状态过滤，非产品内容保持正常搜索逻辑。代码如下：

add_action( 'pre_get_posts', 'filter_out_of_stock_products_in_search' );
function filter_out_of_stock_products_in_search( $query ) {
    // 仅针对前台主搜索查询生效
    if ( ! is_admin() && $query->is_search() && $query->is_main_query() ) {
        $post_types = $query->get( 'post_type' );
        
        // 判断当前查询是否包含产品类型
        if ( is_array( $post_types ) ? in_array( 'product', $post_types ) : $post_types === 'product' ) {
            // 用meta_query添加库存过滤条件，不干扰其他内容的查询参数
            $meta_query = $query->get( 'meta_query', array() );
            $meta_query[] = array(
                'key'     => '_stock_status',
                'value'   => 'instock',
                'compare' => '='
            );
            $query->set( 'meta_query', $meta_query );
        }
    }
}

关键说明 #

1. 范围限制：通过! is_admin()确保代码只在前台生效，不会影响后台的搜索操作。
2. 精准过滤：检查查询的文章类型是否包含product，只对产品应用库存状态过滤，非产品内容不受影响。
3. 安全的条件设置：使用meta_query而非直接覆盖meta_key/meta_value，避免破坏原有查询逻辑，同时支持多条件叠加。

另外提一句：自定义状态的exclude_from_search不生效，是因为WooCommerce的产品搜索逻辑优先读取_stock_status元数据，而非文章状态的exclude_from_search属性，所以必须通过上述库存过滤来统一处理。

内容的提问来源于stack exchange，提问作者user107844