bp_friend_get_total_requests_count

Filters the total friendship request count for a given user.

Description

apply_filters( 'bp_friend_get_total_requests_count', (bool) $count, (int) $user_id ); 

Parameters (2)

0. $count (bool) => count( BP_Friends_Friendship::get_friend_user_ids( $user_id, true ) )
Friendship request count.
1. $user_id (int)
ID of the queried user.

Usage

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

Defined (1)

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

/bp-friends/bp-friends-template.php  
  1. return apply_filters( 'bp_friend_get_total_requests_count', count( BP_Friends_Friendship::get_friend_user_ids( $user_id, true ) ), $user_id );