Changeset 34251

Timestamp:

09/16/2015 10:18:33 PM (9 years ago)

Author:

boonebgorges

Message:

Move new user notification emails to add_action() callbacks.

When a new user is created in various places throughout the interface,
notifications are sent to the site admin and the new user. Previously, these
notifications were fired through direct calls to wp_new_user_notification(),
making it difficult to stop or modify the messages.

This changeset introduces a number of new action hooks in place of direct calls
to wp_new_user_notification(), and hooks the new wrapper function
wp_send_new_user_notifications() to these hooks.

Props dshanske, thomaswm, boonebgorges.
Fixes #33587.

Location:

trunk/src

Files:

• wp-admin/includes/user.php (modified) (1 diff)
• wp-admin/network/site-new.php (modified) (1 diff)
• wp-admin/network/site-users.php (modified) (1 diff)
• wp-admin/network/user-new.php (modified) (1 diff)
• wp-includes/default-filters.php (modified) (1 diff)
• wp-includes/ms-default-filters.php (modified) (1 diff)
• wp-includes/user-functions.php (modified) (1 diff)

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

@@ -177 +177 @@
     } else {
         $user_id = wp_insert_user( $user );
-        wp_new_user_notification( $user_id, null, 'both' );
+        /**
+          * Fires after a new user has been created.
+          *
+          * @since 4.4.0
+          *
+          * @param int $user_id ID of the newly created user.
+          */
+        do_action( 'edit_user_created_user', $user_id );
     }
     return $user_id;

trunk/src/wp-admin/network/site-new.php

@@ -92 +92 @@
         $password = wp_generate_password( 12, false );
         $user_id = wpmu_create_user( $domain, $password, $email );
-        if ( false === $user_id )
+        if ( false === $user_id ) {
             wp_die( __( 'There was an error creating the user.' ) );
-        else
-            wp_new_user_notification( $user_id, null, 'both' );
+        }
+
+        /**
+          * Fires after a new user has been created via the network site-new.php page.
+          *
+          * @since 4.4.0
+          *
+          * @param int $user_id ID of the newly created user.
+          */
+        do_action( 'network_site_new_created_user', $user_id );
     }
 

trunk/src/wp-admin/network/site-users.php

@@ -78 +78 @@
                     $update = 'err_new_dup';
                 } else {
-                    wp_new_user_notification( $user_id, null, 'both' );
                     add_user_to_blog( $id, $user_id, $_POST['new_role'] );
                     $update = 'newuser';
+                    /**
+                      * Fires after a user has been created via the network site-users.php page.
+                      *
+                      * @since 4.4.0
+                      *
+                      * @param int $user_id ID of the newly created user.
+                      */
+                    do_action( 'network_site_users_created_user', $user_id );
                 }
             }

trunk/src/wp-admin/network/user-new.php

@@ -52 +52 @@
             $add_user_errors = new WP_Error( 'add_user_fail', __( 'Cannot add user.' ) );
         } else {
-            wp_new_user_notification( $user_id, null, 'both' );
+            /**
+              * Fires after a new user has been created via the network user-new.php page.
+              *
+              * @since 4.4.0
+              *
+              * @param int $user_id ID of the newly created user.
+              */
+            do_action( 'network_user_new_created_user', $user_id );
             wp_redirect( add_query_arg( array('update' => 'added'), 'user-new.php' ) );
             exit;

trunk/src/wp-includes/default-filters.php

@@ -340 +340 @@
 add_action( 'comment_post', 'wp_new_comment_notify_postauthor' );
 add_action( 'after_password_reset', 'wp_password_change_notification' );
+add_action( 'register_new_user',      'wp_send_new_user_notifications' );
+add_action( 'edit_user_created_user', 'wp_send_new_user_notifications' );
 
 /**

trunk/src/wp-includes/ms-default-filters.php

@@ -28 +28 @@
 add_action( 'wpmu_activate_user', 'wpmu_welcome_user_notification', 10, 3 );
 add_action( 'after_signup_user', 'wpmu_signup_user_notification', 10, 4 );
+add_action( 'network_site_new_created_user',   'wp_send_new_user_notifications' );
+add_action( 'network_site_users_created_user', 'wp_send_new_user_notifications' );
+add_action( 'network_user_new_created_user',   'wp_send_new_user_notifications' );
 add_filter( 'sanitize_user', 'strtolower' );
 

trunk/src/wp-includes/user-functions.php

@@ -2024 +2024 @@
     update_user_option( $user_id, 'default_password_nag', true, true ); //Set up the Password change nag.
 
+    /**
+     * Fires after a new user registration has been recorded.
+     *
+     * @since 4.4.0
+     *
+     * @param int $user_id ID of the newly registered user.
+     */
+    do_action( 'register_new_user', $user_id );
+
+    return $user_id;
+}
+
+/**
+ * Initiate email notifications related to the creation of new users.
+ *
+ * Notifications are sent both to the site admin and to the newly created user.
+ *
+ * @since 4.4.0
+ *
+ * @param int $user_id ID of the newly created user.
+ */
+function wp_send_new_user_notifications( $user_id ) {
     wp_new_user_notification( $user_id, null, 'both' );
-
-    return $user_id;
 }