wp_count_comments

Filters the comments count for a given post.

Description

apply_filters( 'wp_count_comments', (array) $array, (int) $post_id ); 

Parameters (2)

0. $array (array) => array()
An empty array.
1. $post_id (int)
The post id.

Usage

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

Defined (1)

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

/wp-includes/comment.php  
  1. $filtered = apply_filters( 'wp_count_comments', array(), $post_id );