bb_search_pages

The BuddyPress bb search pages hook.

Description

apply_filters( 'bb_search_pages', (bool) $get_page_number_links ); 

Parameters (1)

0. $get_page_number_links — Optional. (bool) => get_page_number_links( array( 'page' => $page, 'total' => $search_count, 'per_page' => $per_page, 'mod_rewrite' => false ) )
The get page number links.

Usage

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

Defined (1)

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

/bp-forums/bbpress/bb-includes/functions.bb-template.php  
  1. if ( $pages = apply_filters( 'bb_search_pages', get_page_number_links( array( 'page' => $page, 'total' => $search_count, 'per_page' => $per_page, 'mod_rewrite' => false ) ) ) )