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( 'wp_mail_failed', $e->getMessage(), $mail_error_data )

A WP_Error object with the phpmailerException message, and an array containing the mail recipient, subject, message, headers, and attachments.

Usage

To run the hook, copy the example below.

// run the action 
do_action( 'wp_mail_failed', $wp_error ); 

The following example is for adding a hook callback.

// define the wp_mail_failed callback 
function action_wp_mail_failed( $wp_error ) { 
    // make action magic happen here... 
}; 
         
// add the action 
add_action( 'wp_mail_failed', 'action_wp_mail_failed', 10, 1 ); 

To remove a hook callback, use the example below.

// remove the action 
remove_action( 'wp_mail_failed', 'action_wp_mail_failed', 10, 1 );