Make WordPress Core


Ignore:
Timestamp:
01/29/2015 11:45:59 AM (9 years ago)
Author:
DrewAPicture
Message:

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

Props ericlewis.
Fixes #31141.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/ms-functions.php

    r31217 r31296  
    435435
    436436/**
    437  * Processes new user registrations.
    438  *
    439  * Checks the data provided by the user during signup. Verifies
    440  * the validity and uniqueness of user names and user email addresses,
    441  * and checks email addresses against admin-provided domain
    442  * whitelists and blacklists.
    443  *
    444  * The hook 'wpmu_validate_user_signup' provides an easy way
    445  * to modify the signup process. The value $result, which is passed
    446  * to the hook, contains both the user-provided info and the error
    447  * messages created by the function. 'wpmu_validate_user_signup' allows
    448  * you to process the data in any way you'd like, and unset the
    449  * relevant errors if necessary.
    450  *
    451  * @since MU
    452  *
    453  * @param string $user_name The login name provided by the user.
     437 * Sanitize and validate data required for a user sign-up.
     438 *
     439 * Verifies the validity and uniqueness of user names and user email addresses,
     440 * and checks email addresses against admin-provided domain whitelists and blacklists.
     441 *
     442 * The {@see 'wpmu_validate_user_signup'} hook provides an easy way to modify the sign-up
     443 * process. The value $result, which is passed to the hook, contains both the user-provided
     444 * info and the error messages created by the function. {@see 'wpmu_validate_user_signup'}
     445 * allows you to process the data in any way you'd like, and unset the relevant errors if
     446 * necessary.
     447 *
     448 * @since MU
     449 *
     450 * @param string $user_name  The login name provided by the user.
    454451 * @param string $user_email The email provided by the user.
    455452 * @return array Contains username, email, and error messages.
Note: See TracChangeset for help on using the changeset viewer.