Changeset 44620 for trunk/src/wp-includes/formatting.php

Timestamp:

01/16/2019 06:15:40 AM (6 years ago)

Author:

pento

Message:

Docs: Improve the sanitize_email filter.

• Remove duplicate parameter names.
• Fix the wrong value being passed in the second parameter.
• Correct the type of the $message parameter.

Props ChriCo.
Fixes #45595.

File:

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

trunk/src/wp-includes/formatting.php

@@ -3457 +3457 @@
          * @since 2.8.0
          *
-         * @param string $email   The sanitized email address.
-         * @param string $email   The email address, as provided to sanitize_email().
-         * @param string $message A message to pass to the user.
+         * @param string $sanitized_email The sanitized email address.
+         * @param string $email           The email address, as provided to sanitize_email().
+         * @param string|null $message    A message to pass to the user. null if email is sanitized.
          */
         return apply_filters( 'sanitize_email', '', $email, 'email_too_short' );
@@ -3532 +3532 @@
 
     // Put the email back together
-    $email = $local . '@' . $domain;
+    $sanitized_email = $local . '@' . $domain;
 
     // Congratulations your email made it!
     /** This filter is documented in wp-includes/formatting.php */
-    return apply_filters( 'sanitize_email', $email, $email, null );
+    return apply_filters( 'sanitize_email', $sanitized_email, $email, null );
 }