sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Docs: Correct parameter type and description for is_email filter.

Browse Source 
Props jenkoian.
Fixes #47793.

git-svn-id: https://develop.svn.wordpress.org/trunk@45703 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov 2019-07-31 01:25:43 +00:00
parent 288681a0b1
commit a8a4c09f33
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/wp-includes/formatting.php
View File

@ -3267,7 +3267,7 @@ function convert_smilies( $text ) {
*
* @param string $email Email address to verify.
* @param bool $deprecated Deprecated.
* @return string|bool Either false or the valid email address.
* @return string|false Valid email address on success, false on failure.
*/
function is_email( $email, $deprecated = false ) {
if ( ! empty( $deprecated ) ) {
@ -3285,9 +3285,9 @@ function is_email( $email, $deprecated = false ) {
*
* @since 2.8.0
*
* @param bool $is_email Whether the email address has passed the is_email() checks. Default false.
* @param string $email The email address being checked.
* @param string $context Context under which the email was tested.
* @param string|false $is_email The email address if successfully passed the is_email() checks, false otherwise.
* @param string $email The email address being checked.
* @param string $context Context under which the email was tested.
*/
return apply_filters( 'is_email', false, $email, 'email_too_short' );
}