bp_activity_can_favorite

Filters whether or not users can favorite activity items.

Description

apply_filters( 'bp_activity_can_favorite', (bool) $true ); 

Parameters (1)

0. $true (bool) => true
Whether or not favoriting is enabled.

Usage

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

Defined (1)

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

/bp-activity/bp-activity-template.php  
  1. return apply_filters( 'bp_activity_can_favorite', true );