WordPress.org
Get WordPress

Make WordPress Core


Ignore:
Timestamp:
04/21/2025 11:47:11 AM (11 months ago)
Author:
johnbillion
Message:

Docs: Improve and standardise the format of placeholder strings that get replaced within email messages.

This prevents the strings being treated as h3 headings by the documentation parser on developer.wordpress.org.

See #63166

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-includes/user.php

    r59927 r60178  
    27592759         *     @type string $message The content of the email.
    27602760         *         The following strings have a special meaning and will get replaced dynamically:
    2761          *         - ###USERNAME###    The current user's username.
    2762          *         - ###ADMIN_EMAIL### The admin email in case this was unexpected.
    2763          *         - ###EMAIL###       The user's email address.
    2764          *         - ###SITENAME###    The name of the site.
    2765          *         - ###SITEURL###     The URL to the site.
     2761         *          - `###USERNAME###`    The current user's username.
     2762         *          - `###ADMIN_EMAIL###` The admin email in case this was unexpected.
     2763         *          - `###EMAIL###`       The user's email address.
     2764         *          - `###SITENAME###`    The name of the site.
     2765         *          - `###SITEURL###`     The URL to the site.
    27662766         *     @type string $headers Headers. Add headers in a newline (\r\n) separated string.
    27672767         * }
    … …  
    28172817         *     @type string $message The content of the email.
    28182818         *         The following strings have a special meaning and will get replaced dynamically:
    2819          *         - ###USERNAME###    The current user's username.
    2820          *         - ###ADMIN_EMAIL### The admin email in case this was unexpected.
    2821          *         - ###NEW_EMAIL###   The new email address.
    2822          *         - ###EMAIL###       The old email address.
    2823          *         - ###SITENAME###    The name of the site.
    2824          *         - ###SITEURL###     The URL to the site.
     2819         *          - `###USERNAME###`    The current user's username.
     2820         *          - `###ADMIN_EMAIL###` The admin email in case this was unexpected.
     2821         *          - `###NEW_EMAIL###`   The new email address.
     2822         *          - `###EMAIL###`       The old email address.
     2823         *          - `###SITENAME###`    The name of the site.
     2824         *          - `###SITEURL###`     The URL to the site.
    28252825         *     @type string $headers Headers.
    28262826         * }
    … …  
    38403840         *
    38413841         * The following strings have a special meaning and will get replaced dynamically:
    3842          * - ###USERNAME###  The current user's username.
    3843          * - ###ADMIN_URL### The link to click on to confirm the email change.
    3844          * - ###EMAIL###     The new email.
    3845          * - ###SITENAME###  The name of the site.
    3846          * - ###SITEURL###   The URL to the site.
     3842         *
     3843         *  - `###USERNAME###`  The current user's username.
     3844         *  - `###ADMIN_URL###` The link to click on to confirm the email change.
     3845         *  - `###EMAIL###`     The new email.
     3846         *  - `###SITENAME###`  The name of the site.
     3847         *  - `###SITEURL###`   The URL to the site.
    38473848         *
    38483849         * @since MU (3.0.0)
    … …  
    42694270     * The following strings have a special meaning and will get replaced dynamically:
    42704271     *
    4271      * ###SITENAME###    The name of the site.
    4272      * ###USER_EMAIL###  The user email for the request.
    4273      * ###DESCRIPTION### Description of the action being performed so the user knows what the email is for.
    4274      * ###MANAGE_URL###  The URL to manage requests.
    4275      * ###SITEURL###     The URL to the site.
     4272     *  - `###SITENAME###`    The name of the site.
     4273     *  - `###USER_EMAIL###`  The user email for the request.
     4274     *  - `###DESCRIPTION###` Description of the action being performed so the user knows what the email is for.
     4275     *  - `###MANAGE_URL###`  The URL to manage requests.
     4276     *  - `###SITEURL###`     The URL to the site.
    42764277     *
    42774278     * @since 4.9.6
    … …  
    43124313     * The following strings have a special meaning and will get replaced dynamically:
    43134314     *
    4314      * ###SITENAME###    The name of the site.
    4315      * ###USER_EMAIL###  The user email for the request.
    4316      * ###DESCRIPTION### Description of the action being performed so the user knows what the email is for.
    4317      * ###MANAGE_URL###  The URL to manage requests.
    4318      * ###SITEURL###     The URL to the site.
     4315     *  - `###SITENAME###`    The name of the site.
     4316     *  - `###USER_EMAIL###`  The user email for the request.
     4317     *  - `###DESCRIPTION###` Description of the action being performed so the user knows what the email is for.
     4318     *  - `###MANAGE_URL###`  The URL to manage requests.
     4319     *  - `###SITEURL###`     The URL to the site.
    43194320     *
    43204321     * @since 5.8.0
    … …  
    45124513     * The following strings have a special meaning and will get replaced dynamically:
    45134514     *
    4514      * ###SITENAME###           The name of the site.
    4515      * ###PRIVACY_POLICY_URL### Privacy policy page URL.
    4516      * ###SITEURL###            The URL to the site.
     4515     *  - `###SITENAME###`           The name of the site.
     4516     *  - `###PRIVACY_POLICY_URL###` Privacy policy page URL.
     4517     *  - `###SITEURL###`            The URL to the site.
    45174518     *
    45184519     * @since 4.9.6
    … …  
    45544555     * The following strings have a special meaning and will get replaced dynamically:
    45554556     *
    4556      * ###SITENAME###           The name of the site.
    4557      * ###PRIVACY_POLICY_URL### Privacy policy page URL.
    4558      * ###SITEURL###            The URL to the site.
     4557     *  - `###SITENAME###`           The name of the site.
     4558     *  - `###PRIVACY_POLICY_URL###` Privacy policy page URL.
     4559     *  - `###SITEURL###`            The URL to the site.
    45594560     *
    45604561     * @since 5.8.0
    … …  
    48744875     * The following strings have a special meaning and will get replaced dynamically:
    48754876     *
    4876      * ###DESCRIPTION### Description of the action being performed so the user knows what the email is for.
    4877      * ###CONFIRM_URL### The link to click on to confirm the account action.
    4878      * ###SITENAME###    The name of the site.
    4879      * ###SITEURL###     The URL to the site.
     4877     *  - `###DESCRIPTION###` Description of the action being performed so the user knows what the email is for.
     4878     *  - `###CONFIRM_URL###` The link to click on to confirm the account action.
     4879     *  - `###SITENAME###`    The name of the site.
     4880     *  - `###SITEURL###`     The URL to the site.
    48804881     *
    48814882     * @since 4.9.6
Note: See TracChangeset for help on using the changeset viewer.