Changeset 49048

Timestamp:

09/25/2020 10:31:27 PM (4 years ago)

Author:

johnbillion

Message:

Upgrade/Install: Introduce the wp_installed_email filter for filtering the contents of the email sent when WordPress is installed, without needing to override the wp_new_blog_notification() pluggable function.

Props Dharm1025, nikolam, johnbillion

Fixes #42133

File:

• trunk/src/wp-admin/includes/upgrade.php (modified) (3 diffs)

trunk/src/wp-admin/includes/upgrade.php

@@ -587 +587 @@
 if ( ! function_exists( 'wp_new_blog_notification' ) ) :
     /**
-     * Notifies the site admin that the setup is complete.
+     * Notifies the site admin that the  is complete.
      *
-     * Sends an email with wp_mail to the new administrator that the site setup is complete,
+     * Sends an email 
      * and provides them with a record of their login credentials.
      *
@@ -595 +595 @@
      *
      * @param string $blog_title Site title.
-     * @param string $blog_url   Site url.
-     * @param int    $user_id    User ID.
-     * @param string $password   User's Password.
+     * @param string $blog_url   Site URL.
+     * @param int    $user_id    Administrator's user ID.
+     * @param string $password   Administrator's password. Note that a placeholder message is
+     *                           usually passed instead of the actual password.
      */
     function wp_new_blog_notification( $blog_title, $blog_url, $user_id, $password ) {
@@ -630 +631 @@
         );
 
-        wp_mail( $email, __( 'New WordPress Site' ), $message );
+        $installed_email = array(
+            'to'      => $email,
+            'subject' => __( 'New WordPress Site' ),
+            'message' => $message,
+            'headers' => '',
+        );
+
+        /**
+         * Filters the contents of the email sent to the site administrator when WordPress is installed.
+         *
+         * @since 5.6.0
+         *
+         * @param array $installed_email {
+         *     Used to build wp_mail().
+         *
+         *     @type string $to      The email address of the recipient.
+         *     @type string $subject The subject of the email.
+         *     @type string $message The content of the email.
+         *     @type string $headers Headers.
+         * }
+         * @param WP_User $user          The site administrator user object.
+         * @param string  $blog_title    The site title.
+         * @param string  $blog_url      The site URL.
+         * @param string  $password      The site administrator's password. Note that a placeholder message
+         *                               is usually passed instead of the user's actual password.
+         */
+        $installed_email = apply_filters( 'wp_installed_email', $installed_email, $user, $blog_title, $blog_url, $password );
+
+        wp_mail(
+            $installed_email['to'],
+            $installed_email['subject'],
+            $installed_email['message'],
+            $installed_email['headers']
+        );
     }
 endif;