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

Filter the comments data before the query takes place.

Description Description

Return a non-null value to bypass WordPress’s 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 int. 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.

Parameters Parameters


(array|int|null) Return an array of comment data to short-circuit WP's comment query, the comment count as an integer if $this->query_vars['count'] is set, or null to allow WP to run its normal queries.


(WP_Comment_Query) The WP_Comment_Query instance, passed by reference.

Top ↑

Source Source

File: wp-includes/class-wp-comment-query.php

View on Trac

Top ↑

Changelog Changelog

Version Description
5.3.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.