Changeset 39086

Timestamp:

11/02/2016 04:26:18 AM (10 years ago)

Author:

helen

Message:

Mail: Set a better error code when triggering wp_mail_failed.

This error code is now... wait for it... wp_mail_failed. Previously, this would have been the originating PHPMailer error code, which could be 0, which would then fail (pass?) the empty() check in the WP_Error constructor, thereby rendering the error object fairly useless. The PHPMailer error code is now located within the WP_Error data.

props Kau-Boy, stephenharris.
fixes #35598.

Location:

trunk

Files:

• src/wp-includes/pluggable.php (modified) (2 diffs)
• tests/phpunit/includes/bootstrap.php (modified) (1 diff)
• tests/phpunit/tests/mail.php (modified) (1 diff)

trunk/src/wp-includes/pluggable.php

@@ -473 +473 @@
 
                 $mail_error_data = compact( 'to', 'subject', 'message', 'headers', 'attachments' );
+                $mail_error_data['phpmailer_exception_code'] = $e->getCode();
 
                 /**
@@ -479 +480 @@
                  * @since 4.4.0
                  *
-                 * @param WP_Error $error A WP_Error object with the phpmailerException code, message, and an array
+                 * @param WP_Error $error A WP_Error object with the phpmailerException message, and an array
                  *                        containing the mail recipient, subject, message, headers, and attachments.
                  */
-                do_action( 'wp_mail_failed', new WP_Error( $e->getCode(), $e->getMessage(), $mail_error_data ) );
+                do_action( 'wp_mail_failed', new WP_Error( 'wp_mail_failed', $e->getMessage(), $mail_error_data ) );
 
                 return false;

trunk/tests/phpunit/includes/bootstrap.php

@@ -52 +52 @@
 // Override the PHPMailer
 require_once( dirname( __FILE__ ) . '/mock-mailer.php' );
-$phpmailer = new MockPHPMailer();
+$phpmailer = new MockPHPMailer( true );
 
 if ( ! defined( 'WP_DEFAULT_THEME' ) ) {

trunk/tests/phpunit/tests/mail.php

@@ -361 +361 @@
                 $this->assertEquals( '', $mailer->Sender );
         }
+
+        /**
+         * @ticket 35598
+         */
+        public function test_phpmailer_exception_thrown() {
+                $to       = 'an_invalid_address';
+                $subject  = 'Testing';
+                $message  = 'Test Message';
+
+                $ma = new MockAction();
+                add_action( 'wp_mail_failed', array( &$ma, 'action' ) );
+
+                wp_mail( $to, $subject, $message );
+
+                $this->assertEquals( 1, $ma->get_call_count() );
+
+                $expected_error_data = array(
+                        'to'          => array( 'an_invalid_address' ),
+                        'subject'     => 'Testing',
+                        'message'     => 'Test Message',
+                        'headers'     => array(),
+                        'attachments' => array(),
+                        'phpmailer_exception_code' => 2,
+                );
+
+                //Retrieve the arguments passed to the 'wp_mail_failed' hook callbacks
+                $all_args = $ma->get_args();
+                $call_args = array_pop( $all_args );
+
+                $this->assertEquals( 'wp_mail_failed', $call_args[0]->get_error_code() );
+                $this->assertEquals( $expected_error_data, $call_args[0]->get_error_data() );
+        }
 }