Changeset 59592

Timestamp:

01/08/2025 12:52:04 PM (19 months ago)

Author:

swissspidy

Message:

I18N: Mail: Make PHPMailer messages translatable.

Adds a new WP_PHPMailer class to leverage the WordPress i18n system with PHPMailer, so that any user-visible error messages can be properly translated.

Props sukhendu2002, swissspidy, audrasjb, iandunn, nacin, mark-k.
Fixes #23311.

Location:

trunk

Files:

• src/wp-includes/class-wp-locale-switcher.php (modified) (2 diffs)
• src/wp-includes/class-wp-phpmailer.php (added)
• src/wp-includes/pluggable.php (modified) (1 diff)
• tests/phpunit/data/languages/de_DE.l10n.php (modified) (1 diff)
• tests/phpunit/data/languages/de_DE.mo (modified) ( previous)
• tests/phpunit/data/languages/de_DE.po (modified) (1 diff)
• tests/phpunit/includes/bootstrap.php (modified) (2 diffs)
• tests/phpunit/includes/mock-mailer.php (modified) (1 diff)
• tests/phpunit/tests/l10n/phpmailerTranslations.php (added)

trunk/src/wp-includes/class-wp-locale-switcher.php

@@ -274 +274 @@
          *
          * @global WP_Locale $wp_locale WordPress date and time locale object.
+         * @global PHPMailer\PHPMailer\PHPMailer $phpmailer
          *
          * @param string $locale The locale to change to.
          */
         private function change_locale( $locale ) {
-                global $wp_locale;
+                global $wp_locale, $phpmailer;
 
                 $this->load_translations( $locale );
@@ -285 +286 @@
 
                 WP_Translation_Controller::get_instance()->set_locale( $locale );
+
+                if ( $phpmailer instanceof WP_PHPMailer ) {
+                        $phpmailer->SetLanguage();
+                }
 
                 /**

trunk/src/wp-includes/pluggable.php

@@ -252 +252 @@
                         require_once ABSPATH . WPINC . '/PHPMailer/SMTP.php';
                         require_once ABSPATH . WPINC . '/PHPMailer/Exception.php';
-                        $phpmailer = new PHPMailer\PHPMailer\PHPMailer( true );
+                        require_once ABSPATH . WPINC . '/class-wp-phpmailer.php';
+                        $phpmailer = new WP_PHPMailer( true );
 
                         $phpmailer::$validator = static function ( $email ) {

trunk/tests/phpunit/data/languages/de_DE.l10n.php

@@ -1 +1 @@
 <?php
-return ['domain'=>NULL,'plural-forms'=>'nplurals=2; plural=n != 1;','messages'=>['html_lang_attribute'=>'de-DE','text directionltr'=>'ltr','number_format_decimal_point'=>',','number_format_thousands_sep'=>'.','Update %s now'=>'Jetzt %s aktualisieren','[%1$s] Confirm Action: %2$s'=>'[%1$s] Aktion bestätigen: %2$s','[%s] Erasure Request Fulfilled'=>'[%s] Löschauftrag ausgeführt','[%s] Personal Data Export'=>'[%s] Export personenbezogener Daten'],'language'=>'de_DE','x-generator'=>'Poedit 2.2.1'];
+return ['domain'=>NULL,'plural-forms'=>'nplurals=2; plural=n != 1;','messages'=>['html_lang_attribute'=>'de-DE','text directionltr'=>'ltr','number_format_decimal_point'=>',','number_format_thousands_sep'=>'.','Update %s now'=>'Jetzt %s aktualisieren','[%1$s] Confirm Action: %2$s'=>'[%1$s] Aktion bestätigen: %2$s','[%s] Erasure Request Fulfilled'=>'[%s] Löschauftrag ausgeführt','[%s] Personal Data Export'=>'[%s] Export personenbezogener Daten', 'You must provide at least one recipient email address.'=>'Du musst mindestens eine Empfänger-E-Mail-Adresse angeben.'],'language'=>'de_DE','x-generator'=>'Poedit 2.2.1'];

trunk/tests/phpunit/data/languages/de_DE.po

@@ -58 +58 @@
 msgid "[%s] Personal Data Export"
 msgstr "[%s] Export personenbezogener Daten"
+
+#: wp-includes/class-wp-phpmailer.php:71
+msgid "You must provide at least one recipient email address."
+msgstr "Du musst mindestens eine Empfänger-E-Mail-Adresse angeben."

trunk/tests/phpunit/includes/bootstrap.php

@@ -247 +247 @@
 $multisite = $multisite || ( defined( 'MULTISITE' ) && MULTISITE );
 
-// Override the PHPMailer.
-require_once __DIR__ . '/mock-mailer.php';
-$phpmailer = new MockPHPMailer( true );
-
 if ( ! defined( 'WP_DEFAULT_THEME' ) ) {
         define( 'WP_DEFAULT_THEME', 'default' );
@@ -305 +301 @@
 // Load WordPress.
 require_once ABSPATH . 'wp-settings.php';
+
+// Override the PHPMailer.
+require_once __DIR__ . '/mock-mailer.php';
+
+$phpmailer = new MockPHPMailer( true );
 
 // Delete any default posts & related data.

trunk/tests/phpunit/includes/mock-mailer.php

@@ -1 +1 @@
 <?php
+/**
+ * Mock PHPMailer class for testing.
+ *
+ * @package WordPress
+ * @subpackage UnitTests
+ * @since 4.5.0
+ */
+
 require_once ABSPATH . 'wp-includes/PHPMailer/PHPMailer.php';
 require_once ABSPATH . 'wp-includes/PHPMailer/Exception.php';
+require_once ABSPATH . 'wp-includes/class-wp-phpmailer.php';
 
-class MockPHPMailer extends PHPMailer\PHPMailer\PHPMailer {
+/**
+ * Test class extending WP_PHPMailer.
+ *
+ * @since 4.5.0
+ */
+class MockPHPMailer extends WP_PHPMailer {
         public $mock_sent = array();