Docs: Correct parameter type and description for is_email filter.

Props jenkoian.
Fixes #47793.
Built from https://develop.svn.wordpress.org/trunk@45703


git-svn-id: http://core.svn.wordpress.org/trunk@45514 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov 2019-07-31 01:26:54 +00:00
parent 383c1df66b
commit fec01b0685
2 changed files with 5 additions and 5 deletions

View File

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

View File

@ -13,7 +13,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '5.3-alpha-45702'; $wp_version = '5.3-alpha-45703';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.