Changeset 52083

Timestamp:

11/09/2021 10:25:40 PM (5 years ago)

Author:

davidbaumwald

Message:

Mail: Add wp_mail_succeeded hook to wp_mail.

Adds a new wp_mail_succeeded action in wp_mail after the mail is sent. Also, adds a disclaimer to the hook's docblock, clarifying that the hook's firing doesn't necessarily mean the recipient received the mail, only that the mail was processed without any errors.

Props birgire, donmhico, johnbillion.
Fixes #53826.

File:

• trunk/src/wp-includes/pluggable.php (modified) (2 diffs)

trunk/src/wp-includes/pluggable.php

@@ -538 +538 @@
                 do_action_ref_array( 'phpmailer_init', array( &$phpmailer ) );
 
+                $mail_data = compact( 'to', 'subject', 'message', 'headers', 'attachments' );
+
                 // Send!
                 try {
-                        return $phpmailer->send();
+                        $send = $phpmailer->send();
+
+                        /**
+                         * Fires after PHPMailer has successfully sent a mail.
+                         *
+                         * The firing of this action does not necessarily mean that the recipient received the
+                         * email successfully. It only means that the `send` method above was able to
+                         * process the request without any errors.
+                         *
+                         * @since 5.9.0
+                         *
+                         * @param array $mail_data An array containing the mail recipient, subject, message, headers, and attachments.
+                         */
+                        do_action( 'wp_mail_succeeded', $mail_data );
+
+                        return $send;
                 } catch ( PHPMailer\PHPMailer\Exception $e ) {
-
-                        $mail_error_data                             = compact( 'to', 'subject', 'message', 'headers', 'attachments' );
-                        $mail_error_data['phpmailer_exception_code'] = $e->getCode();
+                        $mail_data['phpmailer_exception_code'] = $e->getCode();
 
                         /**
@@ -554 +569 @@
                          *                        containing the mail recipient, subject, message, headers, and attachments.
                          */
-                        do_action( 'wp_mail_failed', new WP_Error( 'wp_mail_failed', $e->getMessage(), $mail_error_data ) );
+                        do_action( 'wp_mail_failed', new WP_Error( 'wp_mail_failed', $e->getMessage(), $mail_data ) );
 
                         return false;