From fbce07b386a9fa822db2f0d2138a66b72c5f58bc Mon Sep 17 00:00:00 2001
From: Jeremy Felt <jeremyfelt@git.wordpress.org>
Date: Tue, 29 Sep 2015 01:32:47 +0000
Subject: [PATCH] Docs: Clarify `$user` parameter documentation in
 `wpmu_validate_blog_signup`.

See #32246.


git-svn-id: https://develop.svn.wordpress.org/trunk@34676 602fd350-edb4-49c9-b593-d223f7449a82
---
 src/wp-includes/ms-functions.php | 17 +++++++++--------
 1 file changed, 9 insertions(+), 8 deletions(-)

diff --git a/src/wp-includes/ms-functions.php b/src/wp-includes/ms-functions.php
index 1fc709541c..d6a9861331 100644
--- a/src/wp-includes/ms-functions.php
+++ b/src/wp-includes/ms-functions.php
@@ -588,8 +588,9 @@ function wpmu_validate_user_signup($user_name, $user_email) {
  * @global wpdb   $wpdb
  * @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.
  */
 function wpmu_validate_blog_signup( $blogname, $blog_title, $user = '' ) {
@@ -704,12 +705,12 @@ function wpmu_validate_blog_signup( $blogname, $blog_title, $user = '' ) {
 	 * @param array $result {
 	 *     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.
 	 * }
 	 */
 	return apply_filters( 'wpmu_validate_blog_signup', $result );