bp_get_activity_is_favorite

Filters whether the current activity item is in the current user's favorites.

Description

apply_filters( 'bp_get_activity_is_favorite', (array) $in_array ); 

Parameters (1)

0. $in_array (array) => in_array( $activities_template->activity->id, (array) $activities_template->my_favs )
Whether or not the current activity item is in the current user's favorites.

Usage

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

Defined (1)

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

/bp-activity/bp-activity-template.php  
  1. return (bool) apply_filters( 'bp_get_activity_is_favorite', in_array( $activities_template->activity->id, (array) $activities_template->my_favs ) );