wp_list_comments_args

Filters the arguments used in retrieving the comment list.

Description

apply_filters( 'wp_list_comments_args', (array) $r ); 

Parameters (1)

0. $r (array)
An array of arguments for displaying comments.

Usage

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

Defined (1)

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

/wp-includes/comment-template.php  
  1. $r = apply_filters( 'wp_list_comments_args', $r );