wppaste
WordPress

do_action( 'wp_mail_failed', WP_Error $error )

Since
4.4.0
Fires after a PHPMailer exception is caught.

Compatibility

WordPress
since 4.4.0
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0).

Parameters

$errorWP_Error
A WP_Error object with the PHPMailer\PHPMailer\Exception message, and an array containing the mail recipient, subject, message, headers, attachments, and embeds.

Where this hook fires · 2

  • wp-includes/pluggable.php:455wp_mail()
  • wp-includes/pluggable.php:665wp_mail()

Source code

View on Trac View on GitHub 

			 *			 * @since 4.4.0			 *			 * @param WP_Error $error A WP_Error object with the PHPMailer\PHPMailer\Exception message, and an array			 *                        containing the mail recipient, subject, message, headers, attachments, and embeds.			 */			do_action( 'wp_mail_failed', new WP_Error( 'wp_mail_failed', $e->getMessage(), $mail_data ) ); 			return false;		}	}endif;

Changelog

Introduced in 4.4.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 tag, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.