get_favorites_link

The BuddyPress get favorites link hook.

Description

apply_filters( 'get_favorites_link', (unknown) $get_profile_tab_link, (unknown) $user_id ); 

Parameters (2)

0. $get_profile_tab_link (unknown) => get_profile_tab_link($user_id, 'favorites')
The get profile tab link.
1. $user_id (unknown)
The user id.

Usage

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

Defined (1)

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

/bp-forums/bbpress/bb-includes/functions.bb-template.php  
  1. return apply_filters( 'get_favorites_link', get_profile_tab_link($user_id, 'favorites'), $user_id );