bp_member_forums_screen_favorites

Filters the template to load for the forums favorites screen.

Description

apply_filters( 'bp_member_forums_screen_favorites', (string) $members_single_home ); 

Parameters (1)

0. $members_single_home (string) => 'members/single/home'
Path to the forums favorites template to load.

Usage

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

Defined (1)

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

/bp-forums/bp-forums-screens.php  
  1. bp_core_load_template( apply_filters( 'bp_member_forums_screen_favorites', 'members/single/home' ) );