bp_activity_get_meta

Filters the metadata for a specified activity item.

Description

apply_filters( 'bp_activity_get_meta', (mixed) $retval, (int) $activity_id, (string) $meta_key, (bool) $single ); 

Parameters (4)

0. $retval (mixed)
The meta values for the activity item.
1. $activity_id (int)
ID of the activity item.
2. $meta_key (string)
Meta key for the value being requested.
3. $single (bool)
Whether to return one matched meta key row or all.

Usage

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

Defined (1)

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

/bp-activity/bp-activity-functions.php  
  1. return apply_filters( 'bp_activity_get_meta', $retval, $activity_id, $meta_key, $single );