bbp_get_topic_forum

The bbPress bbp get topic forum hook.

Description

apply_filters( 'bbp_get_topic_forum', (unknown) $bbp_get_forum_title, (unknown) $topic_id, (unknown) $forum_id ); 

Parameters (3)

0. $bbp_get_forum_title (unknown) => bbp_get_forum_title( $forum_id )
The bbp get forum title.
1. $topic_id (unknown)
The topic id.
2. $forum_id (unknown)
The forum id.

Usage

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

Defined (1)

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

/includes/topics/template.php  
  1. return apply_filters( 'bbp_get_topic_forum', bbp_get_forum_title( $forum_id ), $topic_id, $forum_id );