bp_phpmailer_object

Filter PHPMailer object to use.

Description

apply_filters( 'bp_phpmailer_object', (null|PHPMailer) $phpmailer ); 

Specify an alternative version of PHPMailer to use instead of WordPress' default.

Parameters (1)

0. $phpmailer (null|PHPMailer)
The phpmailer class.

Usage

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

Defined (1)

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

/bp-core/classes/class-bp-phpmailer.php  
  1. $phpmailer = apply_filters( 'bp_phpmailer_object', $phpmailer );