bp_activity_get_activity_id

Filters the activity ID being requested.

Description

apply_filters( 'bp_activity_get_activity_id', (BP_Activity_Activity) $bp_activity_activity, (array) $r, (array) $args ); 

Parameters (3)

0. $bp_activity_activity (BP_Activity_Activity) => BP_Activity_Activity::get_id( $r['user_id'], $r['component'], $r['type'], $r['item_id'], $r['secondary_item_id'], $r['action'], $r['content'], $r['date_recorded'] )
ID returned by BP_Activity_Activity get_id() method with provided arguments.
1. $r (array)
Parsed function arguments.
2. $args (array)
Arguments passed to the function.

Usage

To run the hook, copy the example below.
  1. $bp_activity_activity = apply_filters( 'bp_activity_get_activity_id', $bp_activity_activity, $r, $args ); 
  2.  
  3. if ( !empty( $bp_activity_activity ) ) { 
  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_activity_id callback 
  2. function filter_bp_activity_get_activity_id( $bp_activity_activity, $r, $args ) { 
  3. // make filter magic happen here... 
  4. return $bp_activity_activity
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'bp_activity_get_activity_id', 'filter_bp_activity_get_activity_id', 10, 3 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'bp_activity_get_activity_id', 'filter_bp_activity_get_activity_id', 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_activity_id', BP_Activity_Activity::get_id(