bp_activity_get_action

Filters the current action by component and key.

Description

apply_filters( 'bp_activity_get_action', (string|bool) $retval, (string) $component_id, (string) $key ); 

Parameters (3)

0. $retval (string|bool)
The action key.
1. $component_id (string)
The unique string ID of the component.
2. $key (string)
The action key.

Usage

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

Defined (1)

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

/bp-activity/bp-activity-functions.php  
  1. return apply_filters( 'bp_activity_get_action', $retval, $component_id, $key );