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

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
This commit is contained in:
John Blackbourn 2017-08-02 20:42:17 +00:00
parent 43d241f0c4
commit 6a77621be4
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
src/wp-includes/user.php
View File

@ -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