comments_array

Filters the comments array.

Description

apply_filters( 'comments_array', (array) $comments_flat, (int) $post_id ); 

Parameters (2)

0. $comments_flat (array)
Array of comments supplied to the comments template.
1. $post_id (int)
The post id.

Usage

To run the hook, copy the example below.
  1. $comments_flat = apply_filters( 'comments_array', $comments_flat, $post_id ); 
  2.  
  3. if ( !empty( $comments_flat ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the comments_array callback 
  2. function filter_comments_array( $comments_flat, $post_id ) { 
  3. // make filter magic happen here... 
  4. return $comments_flat
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'comments_array', 'filter_comments_array', 10, 2 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'comments_array', 'filter_comments_array', 10, 2 ); 

Defined (1)

The filter is defined in the following location(s).

/wp-includes/comment-template.php  
  1. $wp_query->comments = apply_filters( 'comments_array', $comments_flat, $post->ID );