W3cubDocs

/WordPress

get_comments( string|array $args = ): WP_Comment[]|int[]|int

Retrieves a list of comments.

Description

The comment list can be for the blog as a whole or for an individual post.

Parameters

$argsstring|arrayoptional
Array or string of arguments. See WP_Comment_Query::__construct() for information on accepted arguments.

Default:''

Return

WP_Comment[]|int[]|int List of comments or number of found comments if $count argument is true.

Source

function get_comments( $args = '' ) {
	$query = new WP_Comment_Query();
	return $query->query( $args );
}

Changelog

Version Description
2.7.0 Introduced.

© 2003–2024 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_comments