$this->query_vars['count'] is set, the filter should return the comment count as an integer.</li> <li>When 'ids' === $this->query_vars['fields'], the filter should return an array of comment IDs.</li> <li>Otherwise the filter should return an array of WP_Comment objects.</li> </ul> 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.$comment_dataarray|int|null$this->query_vars['count'] is set, or null to allow WP to run its normal queries.$queryWP_Comment_Querywp-includes/class-wp-comment-query.php:434WP_Comment_Query::get_comments()<?php * * @param array|int|null $comment_data 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. * @param WP_Comment_Query $query The WP_Comment_Query instance, passed by reference. */ $comment_data = apply_filters_ref_array( 'comments_pre_query', array( $comment_data, &$this ) ); if ( null !== $comment_data ) { if ( is_array( $comment_data ) && ! $this->query_vars['count'] ) { $this->comments = $comment_data; } Introduced in 5.3.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
comments property of the current WP_Comment_Query instance.from the docblock