comments_per_page

Filters the number of comments listed per page in the comments list table.

Description

apply_filters( 'comments_per_page', (unknown) $per_page, (unknown) $comment_status ); 

Parameters (2)

0. $per_page (unknown)
The per page.
1. $comment_status (unknown)
The comment status.

Usage

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

Defined (2)

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

/wp-admin/includes/class-wp-screen.php  
  1. $per_page = apply_filters( 'comments_per_page', $per_page, $comment_status ); 
/wp-admin/includes/class-wp-comments-list-table.php  
  1. return apply_filters( 'comments_per_page', $comments_per_page, $comment_status );