get_topic_author

The BuddyPress get topic author hook.

Description

apply_filters( 'get_topic_author', (string) $user_display_name, (unknown) $topic_topic_poster, (unknown) $topic_topic_id ); 

Parameters (3)

0. $user_display_name (string)
The user display name.
1. $topic_topic_poster (unknown)
The topic topic poster.
2. $topic_topic_id (unknown)
The topic topic id.

Usage

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

Defined (1)

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

/bp-forums/bbpress/bb-includes/functions.bb-template.php  
  1. return apply_filters( 'get_topic_author', $user_display_name, $topic->topic_poster, $topic->topic_id ); // $topic->topic_poster = user ID