bp_get_activity_avatar_object_<component>

Filters the activity avatar object based on current activity item component.

Description

apply_filters( 'bp_get_activity_avatar_object_<component>', (string) $user ); 

This is a variable filter dependent on the component used. Possible hooks are bp_get_activity_avatar_object_blog, bp_get_activity_avatar_object_group, and bp_get_activity_avatar_object_user.

Parameters (1)

0. $user (string) => 'user'
Component being displayed.

Usage

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

Defined (1)

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

/bp-activity/bp-activity-template.php  
  1. $object = apply_filters( 'bp_get_activity_avatar_object_' . $current_activity_item->component, 'user' );