wppaste
WordPress

apply_filters( 'comments_array', array $comments, int $post_id )

Since
2.1.0
Filters the comments array.

Compatibility

WordPress
since 2.1.0
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0).

Parameters

$commentsarray
Array of comments supplied to the comments template.
$post_idint
Post ID.

Where this hook fires · 1

  • wp-includes/comment-template.php:1593comments_template()

Source code

View on Trac View on GitHub 

	 *	 * @since 2.1.0	 *	 * @param array $comments Array of comments supplied to the comments template.	 * @param int   $post_id  Post ID.	 */	$wp_query->comments = apply_filters( 'comments_array', $comments_flat, $post->ID ); 	$comments                        = &$wp_query->comments;	$wp_query->comment_count         = count( $wp_query->comments );	$wp_query->max_num_comment_pages = $comment_query->max_num_pages; 	if ( $separate_comments ) {

Changelog

Introduced in 2.1.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 6.8.8 tag, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.