bp_get_the_topic_object_avatar

Filters the avatar of the object associated with the current topic in the loop.

Description

apply_filters( 'bp_get_the_topic_object_avatar', (string) $bp_core_fetch_avatar ); 

Parameters (1)

0. $bp_core_fetch_avatar — Optional. (string) => bp_core_fetch_avatar( array( 'item_id' => $forum_template->topic->object_id, 'type' => $type, 'object' => 'group', 'width' => $width, 'height' => $height, 'alt' => $alt ) )
HTML output for the object associated with the current topic.

Usage

To run the hook, copy the example below.
  1. $bp_core_fetch_avatar = apply_filters( 'bp_get_the_topic_object_avatar', $bp_core_fetch_avatar ); 
  2.  
  3. if ( !empty( $bp_core_fetch_avatar ) ) { 
  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_the_topic_object_avatar callback 
  2. function filter_bp_get_the_topic_object_avatar( $bp_core_fetch_avatar ) { 
  3. // make filter magic happen here... 
  4. return $bp_core_fetch_avatar
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'bp_get_the_topic_object_avatar', 'filter_bp_get_the_topic_object_avatar', 10, 1 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'bp_get_the_topic_object_avatar', 'filter_bp_get_the_topic_object_avatar', 10, 1 ); 

Defined (1)

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

/bp-forums/bp-forums-template.php  
  1. return apply_filters( 'bp_get_the_topic_object_avatar', bp_core_fetch_avatar( array( 'item_id' => $forum_template->topic->object_id, 'type' => $type, 'object' => 'group', 'width' => $width, 'height' => $height, 'alt' => $alt ) ) );