bp_is_friend

Filters the status of friendship between logged in user and given user.

Description

apply_filters( 'bp_is_friend', (unknown) $friends_check_friendship_status, (unknown) $user_id ); 

Parameters (2)

0. $friends_check_friendship_status (unknown) => friends_check_friendship_status( bp_loggedin_user_id(), $user_id )
The friends check friendship status.
1. $user_id (unknown)
The user id.

Usage

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

Defined (1)

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

/bp-friends/bp-friends-template.php  
  1. return apply_filters( 'bp_is_friend', friends_check_friendship_status( bp_loggedin_user_id(), $user_id ), $user_id );