bp_email_get_template

Filter the possible template paths for the specified email object.

Description

apply_filters( 'bp_email_get_template', (callback) $array, (WP_Post) $object ); 

Parameters (2)

0. $array (callback) => array( "{$single}-{$object->post_name}.php", "{$single}.php", "assets/emails/{$single}.php", )
Array of possible template paths.
1. $object (WP_Post)
WP_Post object.

Usage

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

Defined (1)

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

/bp-core/bp-core-functions.php  
  1. return apply_filters( 'bp_email_get_template', array(