wp_mail_failed

Fires after a phpmailerException is caught.

Description

do_action( 'wp_mail_failed', (WP_Error) $wp_error ); 

Parameters (1)

0. $wp_error (WP_Error) => WP_Error( $e->getCode(), $e->getMessage(), $mail_error_data )
A WP_Error object with the phpmailerException code, message, and an array containing the mail recipient, subject, message, headers, and attachments.

Usage

To run the hook, copy the example below.
  1. // run the action 
  2. do_action( 'wp_mail_failed', $wp_error ); 
The following example is for adding a hook callback.
  1. // define the wp_mail_failed callback 
  2. function action_wp_mail_failed( $wp_error ) { 
  3. // make action magic happen here... 
  4. }; 
  5.  
  6. // add the action 
  7. add_action( 'wp_mail_failed', 'action_wp_mail_failed', 10, 1 ); 
To remove a hook callback, use the example below.
  1. // remove the action 
  2. remove_action( 'wp_mail_failed', 'action_wp_mail_failed', 10, 1 ); 

Defined (1)

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

/wp-includes/pluggable.php  
  1. do_action( 'wp_mail_failed', new WP_Error( $e->getCode(), $e->getMessage(), $mail_error_data ) );