bp_get_activity_is_favorite

Return whether the current activity is in a current user's favorites.

Description

bp_get_activity_is_favorite(); 

Usage

  1. if ( !function_exists( 'bp_get_activity_is_favorite' ) ) { 
  2. require_once ABSPATH . PLUGINDIR . 'buddypress/bp-activity/bp-activity-template.php'; 
  3.  
  4.  
  5. // NOTICE! Understand what this does before running. 
  6. $result = bp_get_activity_is_favorite(); 
  7.  

Defined (1)

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

/bp-activity/bp-activity-template.php  
  1. function bp_get_activity_is_favorite() { 
  2. global $activities_template; 
  3.  
  4. /** 
  5. * Filters whether the current activity item is in the current user's favorites. 
  6. * @since 1.2.0 
  7. * @param bool $value Whether or not the current activity item is in the current user's favorites. 
  8. */ 
  9. return (bool) apply_filters( 'bp_get_activity_is_favorite', in_array( $activities_template->activity->id, (array) $activities_template->my_favs ) );