bp_get_friend_friendship_id

Filters the ID of the friendship between the logged in user and the current user in the loop.

Description

apply_filters( 'bp_get_friend_friendship_id', (int) $friendship_id ); 

Parameters (1)

0. $friendship_id (int)
ID of the friendship.

Usage

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

Defined (1)

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

/bp-friends/bp-friends-template.php  
  1. return apply_filters( 'bp_get_friend_friendship_id', $friendship_id );