sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Docs: Clarify $user parameter documentation in wpmu_validate_blog_signup.

Browse Source 
See #32246.


git-svn-id: https://develop.svn.wordpress.org/trunk@34676 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Jeremy Felt 2015-09-29 01:32:47 +00:00
parent f0200152be
commit fbce07b386
1 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
src/wp-includes/ms-functions.php
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 );