apply_filters_ref_array( 'comments_pre_query', array|int|null $comment_data, WP_Comment_Query $query )

Description

Return a non-null value to bypass WordPress’ default comment queries.

The expected return type from this filter depends on the value passed in the request query vars:

• When $this->query_vars['count'] is set, the filter should return the comment count as an integer.
• When 'ids' === $this->query_vars['fields'], the filter should return an array of comment IDs.
• Otherwise the filter should return an array of WP_Comment objects.

Note that if the filter returns an array of comment data, it will be assigned to the comments property of the current WP_Comment_Query instance.

Filtering functions that require pagination information are encouraged to set the found_comments and max_num_pages properties of the WP_Comment_Query object, passed to the filter by reference. If WP_Comment_Query does not perform a database query, it will not have enough information to generate these values itself.