From 6a77621be4e2a7338a6c86abfc3a49855da4b023 Mon Sep 17 00:00:00 2001 From: John Blackbourn Date: Wed, 2 Aug 2017 20:42:17 +0000 Subject: [PATCH] Docs: Correct and improve the documentation for the `send_confirmation_on_profile_email()` function and the `new_user_email_content` filter. See #41017 git-svn-id: https://develop.svn.wordpress.org/trunk@41209 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/user.php | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/src/wp-includes/user.php b/src/wp-includes/user.php index 2a886076ce..d2f57e9be5 100644 --- a/src/wp-includes/user.php +++ b/src/wp-includes/user.php @@ -2591,7 +2591,7 @@ function _wp_get_current_user() { } /** - * Sends an email when an email address change is requested. + * Send a confirmation request email when a change of user email address is attempted. * * @since 3.0.0 * @since 4.9.0 This function was moved from wp-admin/includes/ms.php so it's no longer Multisite specific. @@ -2660,7 +2660,7 @@ All at ###SITENAME### ###SITEURL###' ); /** - * Filters the email text sent when a user changes emails. + * Filters the text of the email sent when a change of user email address is attempted. * * The following strings have a special meaning and will get replaced dynamically: * ###USERNAME### The current user's username. @@ -2673,7 +2673,12 @@ All at ###SITENAME### * @since 4.9.0 This filter is no longer Multisite specific. * * @param string $email_text Text in the email. - * @param string $new_user_email New user email that the current user has changed to. + * @param array $new_user_email { + * Data relating to the new user email address. + * + * @type string $hash The secure hash used in the confirmation link URL. + * @type string $newemail The proposed new email address. + * } */ $content = apply_filters( 'new_user_email_content', $email_text, $new_user_email ); @@ -2690,7 +2695,7 @@ All at ###SITENAME### } /** - * Adds an admin notice alerting the user to check for confirmation email + * Adds an admin notice alerting the user to check for confirmation request email * after email address change. * * @since 3.0.0