bp_get_activity_avatar_object_<component>
Filters the activity avatar object based on current activity item component.
Description
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.
- $user = apply_filters( 'bp_get_activity_avatar_object_{$component}', $user );
- if ( !empty( $user ) ) {
- // everything has led up to this point...
- }
- The following example is for adding a hook callback.
- // define the bp_get_activity_avatar_object_<component> callback
- function filter_bp_get_activity_avatar_object_component( $user ) {
- // make filter magic happen here...
- return $user;
- };
- // add the filter
- 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.
- // remove the filter
- 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
- $object = apply_filters( 'bp_get_activity_avatar_object_' . $current_activity_item->component, 'user' );