Changeset 51738 for trunk/src/wp-includes/user.php

Timestamp:

09/07/2021 09:30:07 PM (3 years ago)

Author:

johnbillion

Message:

Users: Introduce a meta_input argument for wp_insert_user().

This allows custom user meta values to be provided when creating or updating a user in the same way custom post meta can be provided to wp_insert_post() when creating or updating a post.

Also introduces the insert_custom_user_meta to filter these values.

Props desrosj, donmhico

Fixes #41950

File:

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

trunk/src/wp-includes/user.php

@@ -1712 +1712 @@
  * @since 3.6.0 The `aim`, `jabber`, and `yim` fields were removed as default user contact
  *              methods for new installations. See wp_get_user_contact_methods().
- * @since 4.7.0 The user's locale can be passed to `$userdata`.
+ * @since 4.7.0 The `locale` field can be passed to `$userdata`.
  * @since 5.3.0 The `user_activation_key` field can be passed to `$userdata`.
  * @since 5.3.0 The `spam` field can be passed to `$userdata` (Multisite only).
+ * @since 5.9.0 The `meta_input` field can be passed to `$userdata` to allow addition of user meta data.
  *
  * @global wpdb $wpdb WordPress database abstraction object.
@@ -1759 +1760 @@
  *     @type string $role                 User's role.
  *     @type string $locale               User's locale. Default empty.
+ *     @type array  $meta_input           Array of custom user meta values keyed by meta key.
+ *                                        Default empty.
  * }
  * @return int|WP_Error The newly created user's ID or a WP_Error object if the user could not
@@ -2058 +2061 @@
      *
      * Does not include contact methods. These are added using `wp_get_user_contact_methods( $user )`.
+     *
+     * For custom meta fields, see the {@see 'insert_custom_user_meta'} filter.
      *
      * @since 4.4.0
@@ -2084 +2089 @@
      */
     $meta = apply_filters( 'insert_user_meta', $meta, $user, $update, $userdata );
+
+    $custom_meta = array();
+    if ( array_key_exists( 'meta_input', $userdata ) && is_array( $userdata['meta_input'] ) && ! empty( $userdata['meta_input'] ) ) {
+        $custom_meta = $userdata['meta_input'];
+    }
+
+    /**
+     * Filters a user's custom meta values and keys immediately after the user is created or updated
+     * and before any user meta is inserted or updated.
+     *
+     * For non-custom meta fields, see the {@see 'insert_user_meta'} filter.
+     *
+     * @since 5.9.0
+     *
+     * @param array   $custom_meta Array of custom user meta values keyed by meta key.
+     * @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().
+     */
+    $custom_meta = apply_filters( 'insert_custom_user_meta', $custom_meta, $user, $update, $userdata );
+
+    $meta = array_merge( $meta, $custom_meta );
 
     // Update user meta.