bbp_topic_pagination

The bbPress bbp topic pagination hook.

Description

apply_filters( 'bbp_topic_pagination', (int) $var ); 

Parameters (1)

0. $var — Optional. (int) => array ( 'base' => $base, 'format' => '', 'total' => $r['posts_per_page'] === $bbp->topic_query->found_posts ? 1 : ceil( (int) $bbp->topic_query->found_posts / (int) $r['posts_per_page'] ), 'current' => (int) $bbp->topic_query->paged, 'prev_text' => is_rtl() ? '→' : '←', 'next_text' => is_rtl() ? '←' : '→', 'mid_size' => 1 )
The array.

Usage

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

Defined (1)

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

/includes/topics/template.php  
  1. $bbp_topic_pagination = apply_filters( 'bbp_topic_pagination', array (