forum_pages

The BuddyPress forum pages hook.

Description

apply_filters( 'forum_pages', (number) $get_page_number_links, (unknown) $forum_topics ); 

Parameters (2)

0. $get_page_number_links (number) => get_page_number_links( $page, $forum->topics )
The get page number links.
1. $forum_topics (unknown)
The forum topics.

Usage

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

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( 'forum_pages', get_page_number_links( $page, $forum->topics ), $forum->topics ) ) {