Fix an inaccurate summary and description in the DocBlock for wpmu_validate_user_signup().

Props ericlewis.
Fixes #31141.

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


git-svn-id: http://core.svn.wordpress.org/trunk@31277 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2015-01-29 11:46:22 +00:00
parent db993f6598
commit 9a17233ca1
2 changed files with 10 additions and 13 deletions

View File

@ -434,23 +434,20 @@ function is_email_address_unsafe( $user_email ) {
} }
/** /**
* Processes new user registrations. * Sanitize and validate data required for a user sign-up.
* *
* Checks the data provided by the user during signup. Verifies * Verifies the validity and uniqueness of user names and user email addresses,
* the validity and uniqueness of user names and user email addresses, * and checks email addresses against admin-provided domain whitelists and blacklists.
* and checks email addresses against admin-provided domain
* whitelists and blacklists.
* *
* The hook 'wpmu_validate_user_signup' provides an easy way * The {@see 'wpmu_validate_user_signup'} hook provides an easy way to modify the sign-up
* to modify the signup process. The value $result, which is passed * process. The value $result, which is passed to the hook, contains both the user-provided
* to the hook, contains both the user-provided info and the error * info and the error messages created by the function. {@see 'wpmu_validate_user_signup'}
* messages created by the function. 'wpmu_validate_user_signup' allows * allows you to process the data in any way you'd like, and unset the relevant errors if
* you to process the data in any way you'd like, and unset the * necessary.
* relevant errors if necessary.
* *
* @since MU * @since MU
* *
* @param string $user_name The login name provided by the user. * @param string $user_name The login name provided by the user.
* @param string $user_email The email provided by the user. * @param string $user_email The email provided by the user.
* @return array Contains username, email, and error messages. * @return array Contains username, email, and error messages.
*/ */

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.2-alpha-31295'; $wp_version = '4.2-alpha-31296';
/** /**
* 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.