get_comment_pages_count

Calculate the total number of comment pages.

Description

(int) get_comment_pages_count( (constant) $comments = null, (constant) $per_page = null, (null) $threaded = null ); 

Returns (int)

Number of comment pages.

Parameters (3)

0. $comments — Optional. (constant) => null
Array of WP_Comment objects. Defaults to $wp_query->comments
1. $per_page — Optional. (constant) => null
Comments per page.
2. $threaded — Optional. (null) => null
Control over flat or threaded comments.

Usage

  1. if ( !function_exists( 'get_comment_pages_count' ) ) { 
  2.     require_once ABSPATH . WPINC . '/comment.php'; 
  3. } 
  4.   
  5. // Optional array of WP_Comment objects. Defaults to $wp_query->comments 
  6. $comments = null; 
  7.   
  8. // Optional comments per page. 
  9. $per_page = null; 
  10.   
  11. // Optional control over flat or threaded comments. 
  12. $threaded = null; 
  13.   
  14. // NOTICE! Understand what this does before running. 
  15. $result = get_comment_pages_count($comments, $per_page, $threaded); 
  16.     

Defined (1)

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

/wp-includes/comment.php  
  1. function get_comment_pages_count( $comments = null, $per_page = null, $threaded = null ) { 
  2.     global $wp_query; 
  3.  
  4.     if ( null === $comments && null === $per_page && null === $threaded && !empty($wp_query->max_num_comment_pages) ) 
  5.         return $wp_query->max_num_comment_pages; 
  6.  
  7.     if ( ( ! $comments || ! is_array( $comments ) ) && ! empty( $wp_query->comments ) ) 
  8.         $comments = $wp_query->comments; 
  9.  
  10.     if ( empty($comments) ) 
  11.         return 0; 
  12.  
  13.     if ( ! get_option( 'page_comments' ) ) { 
  14.         return 1; 
  15.     } 
  16.  
  17.     if ( !isset($per_page) ) 
  18.         $per_page = (int) get_query_var('comments_per_page'); 
  19.     if ( 0 === $per_page ) 
  20.         $per_page = (int) get_option('comments_per_page'); 
  21.     if ( 0 === $per_page ) 
  22.         return 1; 
  23.  
  24.     if ( !isset($threaded) ) 
  25.         $threaded = get_option('thread_comments'); 
  26.  
  27.     if ( $threaded ) { 
  28.         $walker = new Walker_Comment; 
  29.         $count = ceil( $walker->get_number_of_root_elements( $comments ) / $per_page ); 
  30.     } else { 
  31.         $count = ceil( count( $comments ) / $per_page ); 
  32.     } 
  33.  
  34.     return $count; 
  35. }