bbp_search_results_pagination

The bbPress bbp search results pagination hook.

Description

apply_filters( 'bbp_search_results_pagination', (callback) $var ); 

Parameters (1)

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

Usage

To run the hook, copy the example below.
  1. $var = apply_filters( 'bbp_search_results_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_search_results_pagination callback 
  2. function filter_bbp_search_results_pagination( $var ) { 
  3. // make filter magic happen here... 
  4. return $var
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'bbp_search_results_pagination', 'filter_bbp_search_results_pagination', 10, 1 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'bbp_search_results_pagination', 'filter_bbp_search_results_pagination', 10, 1 ); 

Defined (1)

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

/includes/search/template.php  
  1. apply_filters( 'bbp_search_results_pagination', array(