Changeset 31296 for trunk/src/wp-includes/ms-functions.php

Timestamp:

01/29/2015 11:45:59 AM (10 years ago)

Author:

DrewAPicture

Message:

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

Props ericlewis.
Fixes #31141.

File:

• trunk/src/wp-includes/ms-functions.php (modified) (1 diff)

trunk/src/wp-includes/ms-functions.php

@@ -435 +435 @@
 
 /**
- * Processes new user registrations.
- *
- * 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.
- *
- * 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.
- *
- * @since MU
- *
- * @param string $user_name The login name provided by the user.
+ * Sanitize and validate data required for a user sign-up.
+ *
+ * Verifies the validity and uniqueness of user names and user email addresses,
+ * and checks email addresses against admin-provided domain whitelists and blacklists.
+ *
+ * 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_email The email provided by the user.
  * @return array Contains username, email, and error messages.