Changeset 34676

Timestamp:

09/29/2015 01:32:47 AM (9 years ago)

Author:

jeremyfelt

Message:

Docs: Clarify $user parameter documentation in wpmu_validate_blog_signup.

See #32246.

File:

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

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

@@ -589 +589 @@
  * @global string $domain
  *
- * @param string $blogname   The blog name provided by the user. Must be unique.
- * @param string $blog_title The blog title provided by the user.
+ * @param string         $blogname   The blog name provided by the user. Must be unique.
+ * @param string         $blog_title The blog title provided by the user.
+ * @param WP_User|string $user       Optional. The user object to check against the new site name.
  * @return array Contains the new site data and error messages.
  */
@@ -705 +706 @@
      *     Array of domain, path, blog name, blog title, user and error messages.
      *
-     *     @type string   $domain     Domain for the site.
-     *     @type string   $path       Path for the site. Used in subdirectory installs.
-     *     @type string   $blogname   The unique site name (slug).
-     *     @type string   $blog_title Blog title.
-     *     @type string   $user       User email address.
-     *     @type WP_Error $errors     WP_Error containing any errors found.
+     *     @type string         $domain     Domain for the site.
+     *     @type string         $path       Path for the site. Used in subdirectory installs.
+     *     @type string         $blogname   The unique site name (slug).
+     *     @type string         $blog_title Blog title.
+     *     @type string|WP_User $user       By default, an empty string. A user object if provided.
+     *     @type WP_Error       $errors     WP_Error containing any errors found.
      * }
      */