Changeset 51005

Timestamp:

05/25/2021 05:38:30 PM (4 years ago)

Author:

desrosj

Message:

Users: Pass on the user data received by wp_insert_user() to related hooks.

This adds a new parameter to the action and filter hooks found in wp_insert_user() to pass the raw user data received through $userdata to hooked functions.

This will allow hooked functions to perform more contextual adjustments to new users, and makes supplying custom user meta fields possible.

Props johnbillion, audrasjb.
Fixes #53110.

File:

• trunk/src/wp-includes/user.php (modified) (6 diffs)

trunk/src/wp-includes/user.php

@@ -2013 +2013 @@
      *
      * @since 4.9.0
+     * @since 5.8.0 The $userdata parameter was added.
      *
      * @param array    $data {
@@ -2026 +2027 @@
      *                                   the current UTC timestamp.
      * }
-     * @param bool     $update Whether the user is being updated rather than created.
-     * @param int|null $id     ID of the user to be updated, or NULL if the user is being created.
-     */
-    $data = apply_filters( 'wp_pre_insert_user_data', $data, $update, $update ? (int) $ID : null );
+     * @param bool     $update   Whether the user is being updated rather than created.
+     * @param int|null $id       ID of the user to be updated, or NULL if the user is being created.
+     * @param array    $userdata The raw array of data passed to wp_insert_user().
+     */
+    $data = apply_filters( 'wp_pre_insert_user_data', $data, $update, ( $update ? (int) $ID : null ), $userdata );
 
     if ( empty( $data ) || ! is_array( $data ) ) {
@@ -2055 +2057 @@
      *
      * @since 4.4.0
+     * @since 5.8.0 The $userdata parameter was added.
      *
      * @param array $meta {
@@ -2073 +2076 @@
      *     @type string   $locale               User's locale. Default empty.
      * }
-     * @param WP_User $user   User object.
-     * @param bool    $update Whether the user is being updated rather than created.
-     */
-    $meta = apply_filters( 'insert_user_meta', $meta, $user, $update );
+     * @param WP_User $user     User object.
+     * @param bool    $update   Whether the user is being updated rather than created.
+     * @param array   $userdata The raw array of data passed to wp_insert_user().
+     */
+    $meta = apply_filters( 'insert_user_meta', $meta, $user, $update, $userdata );
 
     // Update user meta.
@@ -2102 +2106 @@
          *
          * @since 2.0.0
+         * @since 5.8.0 The $userdata parameter was added.
          *
          * @param int     $user_id       User ID.
          * @param WP_User $old_user_data Object containing user's data prior to update.
+         * @param array   $userdata      The raw array of data passed to wp_insert_user().
          */
-        do_action( 'profile_update', $user_id, $old_user_data );
+        do_action( 'profile_update', $user_id, $old_user_data, $userdata );
 
         if ( isset( $userdata['spam'] ) && $userdata['spam'] != $old_user_data->spam ) {
@@ -2134 +2140 @@
          *
          * @since 1.5.0
+         * @since 5.8.0 The $userdata parameter was added.
          *
-         * @param int $user_id User ID.
+         * @param int   $user_id  User ID.
+         * @param array $userdata The raw array of data passed to wp_insert_user().
          */
-        do_action( 'user_register', $user_id );
+        do_action( 'user_register', $user_id, $userdata );
     }