WordPress.org

Make WordPress Core

Changeset 41209


Ignore:
Timestamp:
08/02/2017 08:42:17 PM (2 years ago)
Author:
johnbillion
Message:

Docs: Correct and improve the documentation for the send_confirmation_on_profile_email() function and the new_user_email_content filter.

See #41017

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/user.php

    r41200 r41209  
    25922592
    25932593/**
    2594  * Sends an email when an email address change is requested.
     2594 * Send a confirmation request email when a change of user email address is attempted.
    25952595 *
    25962596 * @since 3.0.0
     
    26612661
    26622662        /**
    2663          * Filters the email text sent when a user changes emails.
     2663         * Filters the text of the email sent when a change of user email address is attempted.
    26642664         *
    26652665         * The following strings have a special meaning and will get replaced dynamically:
     
    26742674         *
    26752675         * @param string $email_text     Text in the email.
    2676          * @param string $new_user_email New user email that the current user has changed to.
     2676         * @param array  $new_user_email {
     2677         *     Data relating to the new user email address.
     2678         *
     2679         *     @type string $hash     The secure hash used in the confirmation link URL.
     2680         *     @type string $newemail The proposed new email address.
     2681         * }
    26772682         */
    26782683        $content = apply_filters( 'new_user_email_content', $email_text, $new_user_email );
     
    26912696
    26922697/**
    2693  * Adds an admin notice alerting the user to check for confirmation email
     2698 * Adds an admin notice alerting the user to check for confirmation request email
    26942699 * after email address change.
    26952700 *
Note: See TracChangeset for help on using the changeset viewer.