favorites_pages

The BuddyPress favorites pages hook.

Description

apply_filters( 'favorites_pages', (number) $get_page_number_links, (unknown) $user_user_id ); 

Parameters (2)

0. $get_page_number_links (number) => get_page_number_links( $page, $favorites_total )
The get page number links.
1. $user_user_id (unknown)
The user user id.

Usage

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