the_comments │ filter-hook │ WP 3.1.0

Filters the comment query results.

Usage

add_filter( 'the_comments', 'wp_kama_the_comments_filter' );

/**
 * Function for `the_comments` filter-hook.
 * 
 * @param WP_Comment[] $_comments An array of comments.
 *
 * @return WP_Comment[]
 */
function wp_kama_the_comments_filter( $_comments ){

	// filter...
	return $_comments;
}

$_comments(WP_Comment[])

An array of comments.

Changelog

Where the hook is called

$_comments = apply_filters_ref_array( 'the_comments', array( $_comments, &$this ) );

Where the hook is used in WordPress