comments_number

Filters the comments count for display.

Description

apply_filters( 'comments_number', (string) $output, (number) $number ); 

Parameters (2)

0. $output (string)
A translatable string formatted based on whether the count is equal to 0, 1, or 1+.
1. $number (number)
The number of post comments.

Usage

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

Defined (1)

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

/wp-includes/comment-template.php  
  1. return apply_filters( 'comments_number', $output, $number );