Changeset 53698

Timestamp:

07/12/2022 09:03:39 PM (2 years ago)

Author:

johnbillion

Message:

Users: Allow conditional supression of the email notifications that are sent when a new user account is registered.

This introduces the following new filters:

• wp_send_new_user_notification_to_admin
• wp_send_new_user_notification_to_user

Props janthiel, costdev, audrasjb, peterwilsoncc

Fixes #54874

Location:

trunk

Files:

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

trunk/src/wp-includes/pluggable.php

@@ -2111 +2111 @@
         $blogname = wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES );
 
-        if ( 'user' !== $notify ) {
+        /**
+         * Filters whether the admin is notified of a new user registration.
+         *
+         * @since 6.1.0
+         *
+         * @param bool    $send Whether to send the email. Default true.
+         * @param WP_User $user User object for new user.
+         */
+        $send_notification_to_admin = apply_filters( 'wp_send_new_user_notification_to_admin', true, $user );
+
+        if ( 'user' !== $notify && true === $send_notification_to_admin ) {
             $switched_locale = switch_to_locale( get_locale() );
 
@@ -2159 +2169 @@
         }
 
+        /**
+         * Filters whether the user is notified of their new user registration.
+         *
+         * @since 6.1.0
+         *
+         * @param bool    $send Whether to send the email. Default true.
+         * @param WP_User $user User object for new user.
+         */
+        $send_notification_to_user = apply_filters( 'wp_send_new_user_notification_to_user', true, $user );
+
         // `$deprecated` was pre-4.3 `$plaintext_pass`. An empty `$plaintext_pass` didn't sent a user notification.
-        if ( 'admin' === $notify || ( empty( $deprecated ) && empty( $notify ) ) ) {
+        if ( 'admin' === $notify || true !== $send_notification_to_user || ( empty( $deprecated ) && empty( $notify ) ) ) {
             return;
         }

trunk/tests/phpunit/tests/user.php

@@ -1345 +1345 @@
 
     /**
+     * Test that admin notification of a new user registration is dependent
+     * on the 'wp_send_new_user_notification_to_admin' filter.
+     *
+     * @dataProvider data_wp_send_new_user_notification_filters
+     *
+     * @ticket 54874
+     *
+     * @covers ::wp_new_user_notification
+     *
+     * @param bool   $expected Whether the email should be sent.
+     * @param string $callback The callback to pass to the filter.
+     */
+    public function test_wp_send_new_user_notification_to_admin_filter( $expected, $callback ) {
+        reset_phpmailer_instance();
+
+        add_filter( 'wp_send_new_user_notification_to_admin', $callback );
+
+        wp_new_user_notification( self::$contrib_id, null, 'admin' );
+
+        $mailer    = tests_retrieve_phpmailer_instance();
+        $recipient = $mailer->get_recipient( 'to' );
+        $actual    = $recipient ? WP_TESTS_EMAIL === $recipient->address : false;
+
+        $this->assertSame( $expected, $actual, 'Admin email result was not as expected in test_wp_send_new_user_notification_to_admin_filter' );
+    }
+
+    /**
+     * Test that user notification of a new user registration is dependent
+     * on the 'wp_send_new_user_notification_to_user' filter.
+     *
+     * @dataProvider data_wp_send_new_user_notification_filters
+     *
+     * @ticket 54874
+     *
+     * @covers ::wp_new_user_notification
+     *
+     * @param bool   $expected Whether the email should be sent.
+     * @param string $callback The callback to pass to the filter.
+     */
+    public function test_wp_send_new_user_notification_to_user_filter( $expected, $callback ) {
+        reset_phpmailer_instance();
+
+        add_filter( 'wp_send_new_user_notification_to_user', $callback );
+
+        wp_new_user_notification( self::$contrib_id, null, 'user' );
+
+        $mailer    = tests_retrieve_phpmailer_instance();
+        $recipient = $mailer->get_recipient( 'to' );
+        $actual    = $recipient ? 'blackburn@battlefield3.com' === $recipient->address : false;
+
+        $this->assertSame( $expected, $actual, 'User email result was not as expected in test_wp_send_new_user_notification_to_user_filter' );
+    }
+
+    /**
+     * Data provider.
+     *
+     * @return array
+     */
+    public function data_wp_send_new_user_notification_filters() {
+        return array(
+            'true'          => array(
+                'expected' => true,
+                'callback' => '__return_true',
+            ),
+            'false'         => array(
+                'expected' => false,
+                'callback' => '__return_false',
+            ),
+            'null'          => array(
+                'expected' => false,
+                'callback' => '__return_null',
+            ),
+            'empty array'   => array(
+                'expected' => false,
+                'callback' => '__return_empty_array',
+            ),
+            'zero int'      => array(
+                'expected' => false,
+                'callback' => '__return_zero',
+            ),
+            'zero float'    => array(
+                'expected' => false,
+                'callback' => array( $this, 'cb_return_zero_float' ),
+            ),
+            'zero string'   => array(
+                'expected' => false,
+                'callback' => array( $this, 'cb_return_zero_string' ),
+            ),
+            'array( true )' => array(
+                'expected' => false,
+                'callback' => array( $this, 'cb_return_array_true' ),
+            ),
+        );
+    }
+
+    /**
+     * Callback that returns 0.0.
+     *
+     * @return float 0.0.
+     */
+    public function cb_return_zero_float() {
+        return 0.0;
+    }
+
+    /**
+     * Callback that returns '0'.
+     *
+     * @return string '0'.
+     */
+    public function cb_return_zero_string() {
+        return '0';
+    }
+
+    /**
+     * Callback that returns array( true ).
+     *
+     * @return array array( true )
+     */
+    public function cb_return_array_true() {
+        return array( true );
+    }
+
+    /**
      * Ensure blog's admin email change notification emails do not contain encoded HTML entities
      *