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
This commit is contained in:
parent
f0200152be
commit
fbce07b386
@ -590,6 +590,7 @@ function wpmu_validate_user_signup($user_name, $user_email) {
|
|||||||
*
|
*
|
||||||
* @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 = '' ) {
|
||||||
@ -708,7 +709,7 @@ function wpmu_validate_blog_signup( $blogname, $blog_title, $user = '' ) {
|
|||||||
* @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.
|
||||||
* }
|
* }
|
||||||
*/
|
*/
|
||||||
|
Loading…
Reference in New Issue
Block a user