Docs: Clarify `$user` parameter documentation in `wpmu_validate_blog_signup`.

See #32246.

Built from https://develop.svn.wordpress.org/trunk@34676


git-svn-id: http://core.svn.wordpress.org/trunk@34640 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Jeremy Felt 2015-09-29 01:33:27 +00:00
parent 5f09357c21
commit d5b2929dbb
2 changed files with 10 additions and 9 deletions

View File

@ -588,8 +588,9 @@ function wpmu_validate_user_signup($user_name, $user_email) {
* @global wpdb $wpdb * @global wpdb $wpdb
* @global string $domain * @global string $domain
* *
* @param string $blogname The blog name provided by the user. Must be unique. * @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 $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. * @return array Contains the new site data and error messages.
*/ */
function wpmu_validate_blog_signup( $blogname, $blog_title, $user = '' ) { 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 { * @param array $result {
* Array of domain, path, blog name, blog title, user and error messages. * Array of domain, path, blog name, blog title, user and error messages.
* *
* @type string $domain Domain for the site. * @type string $domain Domain for the site.
* @type string $path Path for the site. Used in subdirectory installs. * @type string $path Path for the site. Used in subdirectory installs.
* @type string $blogname The unique site name (slug). * @type string $blogname The unique site name (slug).
* @type string $blog_title Blog title. * @type string $blog_title Blog title.
* @type string $user User email address. * @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. * @type WP_Error $errors WP_Error containing any errors found.
* } * }
*/ */
return apply_filters( 'wpmu_validate_blog_signup', $result ); return apply_filters( 'wpmu_validate_blog_signup', $result );

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.4-alpha-34675'; $wp_version = '4.4-alpha-34676';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.