Changeset 45703

Timestamp:

07/31/2019 01:25:43 AM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Correct parameter type and description for is_email filter.

Props jenkoian.
Fixes #47793.

File:

• trunk/src/wp-includes/formatting.php (modified) (2 diffs)

trunk/src/wp-includes/formatting.php

@@ -3268 +3268 @@
  * @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 ) {
@@ -3286 +3286 @@
          * @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' );