Changeset 47109

Timestamp:

01/24/2020 05:18:37 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve documentation for add_user_to_blog(), add_existing_user_to_blog(), and add_new_user_to_blog().

See #48303.

File:

• trunk/src/wp-includes/ms-functions.php (modified) (5 diffs)

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

@@ -159 +159 @@
  * @param int    $user_id ID of the user you're adding.
  * @param string $role    The role you want the user to have
- * @return true|WP_Error
+ * @return true|WP_Error True on success or a WP_Error object if the user doesn't exist
+ *                       or could not be added.
  */
 function add_user_to_blog( $blog_id, $user_id, $role ) {
@@ -1196 +1197 @@
          * @since MU (3.0.0)
          *
-         * @param int   $user_id  User ID.
-         * @param int   $password User password.
-         * @param array $meta     Signup meta data.
+         * @param int    $user_id  User ID.
+         * @param string $password User password.
+         * @param array  $meta     Signup meta data.
          */
         do_action( 'wpmu_activate_user', $user_id, $password, $meta );
@@ -2141 +2142 @@
  * @since MU (3.0.0)
  *
- * @param array $details
- * @return true|WP_Error|void
+ * @param array $details User details.
+ * @return true|WP_Error|void True on success or a WP_Error object if the user doesn't exist
+ *                            or could not be added. Void if $details array was not provided.
  */
 function add_existing_user_to_blog( $details = false ) {
@@ -2154 +2156 @@
          * @since MU (3.0.0)
          *
-         * @param int   $user_id User ID.
-         * @param mixed $result  True on success or a WP_Error object if the user doesn't exist
-         *                       or could not be added.
+         * @param int           $user_id User ID.
+         * @param true|WP_Error $result  True on success or a WP_Error object if the user doesn't exist
+         *                               or could not be added.
          */
         do_action( 'added_existing_user', $details['user_id'], $result );
@@ -2173 +2175 @@
  * @see add_user_to_blog()
  *
- * @param int   $user_id
- * @param mixed $password Ignored.
- * @param array $meta
+ * @param int    $user_id  User ID.
+ * @param string $password User password. Ignored.
+ * @param array  $meta     Signup meta data.
  */
 function add_new_user_to_blog( $user_id, $password, $meta ) {