diff options
| author | Angie Byron <webchick@24967.no-reply.drupal.org> | 2010-05-05 07:04:17 +0000 |
|---|---|---|
| committer | Angie Byron <webchick@24967.no-reply.drupal.org> | 2010-05-05 07:04:17 +0000 |
| commit | 08a07d779575a8c3c28b48060f3273ca398bdce7 (patch) | |
| tree | ee1d8b8c9484e282d7d56b729255732bcf88670d /modules | |
| parent | 4ce4c4ebf0d38560b0bf524c14641d50decfcb8c (diff) | |
| download | brdo-08a07d779575a8c3c28b48060f3273ca398bdce7.tar.gz brdo-08a07d779575a8c3c28b48060f3273ca398bdce7.tar.bz2 | |
#764426 by aaronmontana, rickvug: Fixed user_validate_mail() is undocumented.
Diffstat (limited to 'modules')
| -rw-r--r-- | modules/user/user.module | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/modules/user/user.module b/modules/user/user.module index 0f3318cde..0483b5d33 100644 --- a/modules/user/user.module +++ b/modules/user/user.module @@ -575,6 +575,19 @@ function user_validate_name($name) { } } +/** + * Validates a user's email address. + * + * Checks that a user's email address exists and follows all standard + * validation rules. Returns error messages when the address is invalid. + * + * @param $mail + * A user's email address. + * + * @return + * If the address is invalid, a human-readable error message is returned. + * If the address is valid, nothing is returned. + */ function user_validate_mail($mail) { $mail = trim($mail); if (!$mail) { |