WP_Comment_Query::query( string|array $query ): array|int

Sets up the WordPress query for retrieving comments.


Parameters

$query string|array Required
Array or URL query string of parameters.

Top ↑

Return

array|int List of comments, or number of comments when 'count' is passed as a query var.


Top ↑

Source

File: wp-includes/class-wp-comment-query.php. View all references

public function query( $query ) {
	$this->query_vars = wp_parse_args( $query );
	return $this->get_comments();
}


Top ↑

Changelog

Changelog
Version Description
4.2.0 Moved parsing to WP_Comment_Query::parse_query().
4.1.0 Introduced 'comment__in', 'comment__not_in', 'post_author__in', 'post_author__not_in', 'author__in', 'author__not_in', 'post__in', 'post__not_in', 'include_unapproved', 'type__in', and 'type__not_in' arguments to $query_vars.
3.1.0 Introduced.

Top ↑

User Contributed Notes

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