Changeset 52204 for trunk/src/wp-admin/includes/user.php

Timestamp:

11/18/2021 01:48:43 PM (4 years ago)

Author:

johnbillion

Message:

Docs: Various corrections and improvements relating to types used in inline documentation.

See #53399

File:

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

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

@@ -26 +26 @@
  *
  * @param int $user_id Optional. User ID.
- * @return int|WP_Error User ID of the updated user.
+ * @return int|WP_Error User ID of the updated user or WP_Error on failure.
  */
 function edit_user( $user_id = 0 ) {
@@ -235 +235 @@
          * @since 4.4.0
          *
-         * @param int    $user_id ID of the newly created user.
-         * @param string $notify  Type of notification that should happen. See wp_send_new_user_notifications()
-         *                        for more information on possible values.
+         * @param int|WP_Error $user_id ID of the newly created user or WP_Error on failure.
+         * @param string       $notify  Type of notification that should happen. See
+         *                              wp_send_new_user_notifications() for more information.
          */
         do_action( 'edit_user_created_user', $user_id, $notify );