From 9a17233ca132ff819f2058a9701faad6092b0c59 Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Thu, 29 Jan 2015 11:46:22 +0000 Subject: [PATCH] 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 --- wp-includes/ms-functions.php | 21 +++++++++------------ wp-includes/version.php | 2 +- 2 files changed, 10 insertions(+), 13 deletions(-) diff --git a/wp-includes/ms-functions.php b/wp-includes/ms-functions.php index f2df7e327c..d17daaf397 100644 --- a/wp-includes/ms-functions.php +++ b/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. */ diff --git a/wp-includes/version.php b/wp-includes/version.php index b1b3deff7c..b1834c5d5e 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -4,7 +4,7 @@ * * @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.