bp_get_forum_topic_type

Filters the currently viewed topic list type.

Description

apply_filters( 'bp_get_forum_topic_type', (string) $bp_current_action ); 

Eg, newest,, popular, etc.

Parameters (1)

0. $bp_current_action (string) => bp_current_action()
Currently viewed topic list type.

Usage

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