From 08409d8d33917cec7fde7d2db558a394e3e18193 Mon Sep 17 00:00:00 2001 From: "Drew Jaynes (DrewAPicture)" Date: Thu, 29 Jan 2015 11:45:59 +0000 Subject: [PATCH] Fix an inaccurate summary and description in the DocBlock for `wpmu_validate_user_signup()`. Props ericlewis. Fixes #31141. git-svn-id: https://develop.svn.wordpress.org/trunk@31296 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/ms-functions.php | 21 +++++++++------------ 1 file changed, 9 insertions(+), 12 deletions(-) diff --git a/src/wp-includes/ms-functions.php b/src/wp-includes/ms-functions.php index f2df7e327c..d17daaf397 100644 --- a/src/wp-includes/ms-functions.php +++ b/src/wp-includes/ms-functions.php @@ -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 - * the validity and uniqueness of user names and user email addresses, - * and checks email addresses against admin-provided domain - * whitelists and blacklists. + * Verifies the validity and uniqueness of user names and user email addresses, + * and checks email addresses against admin-provided domain whitelists and blacklists. * - * The hook 'wpmu_validate_user_signup' provides an easy way - * to modify the signup process. The value $result, which is passed - * to the hook, contains both the user-provided info and the error - * messages created by the function. 'wpmu_validate_user_signup' allows - * you to process the data in any way you'd like, and unset the - * relevant errors if necessary. + * The {@see 'wpmu_validate_user_signup'} hook provides an easy way to modify the sign-up + * process. The value $result, which is passed to the hook, contains both the user-provided + * info and the error messages created by the function. {@see 'wpmu_validate_user_signup'} + * allows you to process the data in any way you'd like, and unset the relevant errors if + * necessary. * * @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. * @return array Contains username, email, and error messages. */