favorites_link

The BuddyPress favorites link hook.

Description

apply_filters( 'favorites_link', (unknown) $get_favorites_link ); 

Parameters (1)

0. $get_favorites_link (unknown) => get_favorites_link( $user_id )
The get favorites link.

Usage

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

Defined (1)

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

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