bp_get_total_favorite_count_for_user

Filters the total favorite count for a user.

Description

apply_filters( 'bp_get_total_favorite_count_for_user', (int|bool) $retval, (int) $user_id ); 

Parameters (2)

0. $retval (int|bool)
Total favorite count for a user. False on no favorites.
1. $user_id (int)
ID of the queried user.

Usage

To run the hook, copy the example below.
  1. $retval = apply_filters( 'bp_get_total_favorite_count_for_user', $retval, $user_id ); 
  2.  
  3. if ( !empty( $retval ) ) { 
  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_total_favorite_count_for_user callback 
  2. function filter_bp_get_total_favorite_count_for_user( $retval, $user_id ) { 
  3. // make filter magic happen here... 
  4. return $retval
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'bp_get_total_favorite_count_for_user', 'filter_bp_get_total_favorite_count_for_user', 10, 2 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'bp_get_total_favorite_count_for_user', 'filter_bp_get_total_favorite_count_for_user', 10, 2 ); 

Defined (1)

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

/bp-activity/bp-activity-template.php  
  1. return apply_filters( 'bp_get_total_favorite_count_for_user', $retval, $user_id );