HostForge-Systems/wordpress
Template
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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

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

See #63166
Built from https://develop.svn.wordpress.org/trunk@60178


git-svn-id: http://core.svn.wordpress.org/trunk@59514 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
John Blackbourn
2025-04-21 11:49:31 +00:00
parent 4faa2950fe
commit d68311701e
7 changed files with 71 additions and 60 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
wp-admin/includes/misc.php
View File

@@ -1483,11 +1483,12 @@ All at ###SITENAME###
* Filters the text of the email sent when a change of site admin email address is attempted.
*
* The following strings have a special meaning and will get replaced dynamically:
* - ###USERNAME### The current user's username.
* - ###ADMIN_URL### The link to click on to confirm the email change.
* - ###EMAIL### The proposed new site admin email address.
* - ###SITENAME### The name of the site.
* - ###SITEURL### The URL to the site.
*
* - `###USERNAME###` The current user's username.
* - `###ADMIN_URL###` The link to click on to confirm the email change.
* - `###EMAIL###` The proposed new site admin email address.
* - `###SITENAME###` The name of the site.
* - `###SITEURL###` The URL to the site.
*
* @since MU (3.0.0)
* @since 4.9.0 This filter is no longer Multisite specific.

11
wp-admin/includes/privacy-tools.php
View File

@@ -613,7 +613,7 @@ function wp_privacy_send_personal_data_export_email( $request_id ) {
/**
* Filters the recipient of the personal data export email notification.
* Should be used with great caution to avoid sending the data export link to wrong emails.
* Should be used with great caution to avoid sending the data export link to the wrong email.
*
* @since 5.3.0
*
@@ -678,10 +678,11 @@ All at ###SITENAME###
* Filters the text of the email sent with a personal data export file.
*
* The following strings have a special meaning and will get replaced dynamically:
* ###EXPIRATION### The date when the URL will be automatically deleted.
* ###LINK### URL of the personal data export file for the user.
* ###SITENAME### The name of the site.
* ###SITEURL### The URL to the site.
*
* - `###EXPIRATION###` The date when the URL will be automatically deleted.
* - `###LINK###` URL of the personal data export file for the user.
* - `###SITENAME###` The name of the site.
* - `###SITEURL###` The URL to the site.
*
* @since 4.9.6
* @since 5.3.0 Introduced the `$email_data` array.

7
wp-admin/ms-delete-site.php
View File

@@ -75,6 +75,13 @@ All at ###SITENAME###
/**
* Filters the text for the email sent to the site admin when a request to delete a site in a Multisite network is submitted.
*
* The following strings have a special meaning and will get replaced dynamically:
*
* - `###USERNAME###` The current user's username.
* - `###URL_DELETE###` The link to click on to confirm the site deletion.
* - `###SITENAME###` The name of the site.
* - `###SITEURL###` The URL to the site.
*
* @since 3.0.0
*
* @param string $content The email text.

8
wp-includes/functions.php
View File

@@ -8180,10 +8180,10 @@ All at ###SITENAME###
* @type string $subject The subject of the email.
* @type string $message The content of the email.
* The following strings have a special meaning and will get replaced dynamically:
* - ###OLD_EMAIL### The old site admin email address.
* - ###NEW_EMAIL### The new site admin email address.
* - ###SITENAME### The name of the site.
* - ###SITEURL### The URL to the site.
* - `###OLD_EMAIL###` The old site admin email address.
* - `###NEW_EMAIL###` The new site admin email address.
* - `###SITENAME###` The name of the site.
* - `###SITEURL###` The URL to the site.
* @type string $headers Headers.
* }
* @param string $old_email The old site admin email address.

19
wp-includes/ms-functions.php
View File

@@ -2816,11 +2816,12 @@ All at ###SITENAME###
* Filters the text of the email sent when a change of network admin email address is attempted.
*
* The following strings have a special meaning and will get replaced dynamically:
* ###USERNAME### The current user's username.
* ###ADMIN_URL### The link to click on to confirm the email change.
* ###EMAIL### The proposed new network admin email address.
* ###SITENAME### The name of the network.
* ###SITEURL### The URL to the network.
*
* - `###USERNAME###` The current user's username.
* - `###ADMIN_URL###` The link to click on to confirm the email change.
* - `###EMAIL###` The proposed new network admin email address.
* - `###SITENAME###` The name of the network.
* - `###SITEURL###` The URL to the network.
*
* @since 4.9.0
*
@@ -2927,10 +2928,10 @@ All at ###SITENAME###
* @type string $subject The subject of the email.
* @type string $message The content of the email.
* The following strings have a special meaning and will get replaced dynamically:
* - ###OLD_EMAIL### The old network admin email address.
* - ###NEW_EMAIL### The new network admin email address.
* - ###SITENAME### The name of the network.
* - ###SITEURL### The URL to the site.
* - `###OLD_EMAIL###` The old network admin email address.
* - `###NEW_EMAIL###` The new network admin email address.
* - `###SITENAME###` The name of the network.
* - `###SITEURL###` The URL to the site.
* @type string $headers Headers.
* }
* @param string $old_email The old network admin email address.

73
wp-includes/user.php
View File

@@ -2758,11 +2758,11 @@ All at ###SITENAME###
* @type string $subject The subject of the email.
* @type string $message The content of the email.
* The following strings have a special meaning and will get replaced dynamically:
* - ###USERNAME### The current user's username.
* - ###ADMIN_EMAIL### The admin email in case this was unexpected.
* - ###EMAIL### The user's email address.
* - ###SITENAME### The name of the site.
* - ###SITEURL### The URL to the site.
* - `###USERNAME###` The current user's username.
* - `###ADMIN_EMAIL###` The admin email in case this was unexpected.
* - `###EMAIL###` The user's email address.
* - `###SITENAME###` The name of the site.
* - `###SITEURL###` The URL to the site.
* @type string $headers Headers. Add headers in a newline (\r\n) separated string.
* }
* @param array $user The original user array.
@@ -2816,12 +2816,12 @@ All at ###SITENAME###
* @type string $subject The subject of the email.
* @type string $message The content of the email.
* The following strings have a special meaning and will get replaced dynamically:
* - ###USERNAME### The current user's username.
* - ###ADMIN_EMAIL### The admin email in case this was unexpected.
* - ###NEW_EMAIL### The new email address.
* - ###EMAIL### The old email address.
* - ###SITENAME### The name of the site.
* - ###SITEURL### The URL to the site.
* - `###USERNAME###` The current user's username.
* - `###ADMIN_EMAIL###` The admin email in case this was unexpected.
* - `###NEW_EMAIL###` The new email address.
* - `###EMAIL###` The old email address.
* - `###SITENAME###` The name of the site.
* - `###SITEURL###` The URL to the site.
* @type string $headers Headers.
* }
* @param array $user The original user array.
@@ -3839,11 +3839,12 @@ All at ###SITENAME###
* 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.
* - ###ADMIN_URL### The link to click on to confirm the email change.
* - ###EMAIL### The new email.
* - ###SITENAME### The name of the site.
* - ###SITEURL### The URL to the site.
*
* - `###USERNAME###` The current user's username.
* - `###ADMIN_URL###` The link to click on to confirm the email change.
* - `###EMAIL###` The new email.
* - `###SITENAME###` The name of the site.
* - `###SITEURL###` The URL to the site.
*
* @since MU (3.0.0)
* @since 4.9.0 This filter is no longer Multisite specific.
@@ -4268,11 +4269,11 @@ All at ###SITENAME###
*
* The following strings have a special meaning and will get replaced dynamically:
*
* ###SITENAME### The name of the site.
* ###USER_EMAIL### The user email for the request.
* ###DESCRIPTION### Description of the action being performed so the user knows what the email is for.
* ###MANAGE_URL### The URL to manage requests.
* ###SITEURL### The URL to the site.
* - `###SITENAME###` The name of the site.
* - `###USER_EMAIL###` The user email for the request.
* - `###DESCRIPTION###` Description of the action being performed so the user knows what the email is for.
* - `###MANAGE_URL###` The URL to manage requests.
* - `###SITEURL###` The URL to the site.
*
* @since 4.9.6
* @deprecated 5.8.0 Use {@see 'user_request_confirmed_email_content'} instead.
@@ -4311,11 +4312,11 @@ All at ###SITENAME###
* The email is sent to an administrator when a user request is confirmed.
* The following strings have a special meaning and will get replaced dynamically:
*
* ###SITENAME### The name of the site.
* ###USER_EMAIL### The user email for the request.
* ###DESCRIPTION### Description of the action being performed so the user knows what the email is for.
* ###MANAGE_URL### The URL to manage requests.
* ###SITEURL### The URL to the site.
* - `###SITENAME###` The name of the site.
* - `###USER_EMAIL###` The user email for the request.
* - `###DESCRIPTION###` Description of the action being performed so the user knows what the email is for.
* - `###MANAGE_URL###` The URL to manage requests.
* - `###SITEURL###` The URL to the site.
*
* @since 5.8.0
*
@@ -4511,9 +4512,9 @@ All at ###SITENAME###
*
* The following strings have a special meaning and will get replaced dynamically:
*
* ###SITENAME### The name of the site.
* ###PRIVACY_POLICY_URL### Privacy policy page URL.
* ###SITEURL### The URL to the site.
* - `###SITENAME###` The name of the site.
* - `###PRIVACY_POLICY_URL###` Privacy policy page URL.
* - `###SITEURL###` The URL to the site.
*
* @since 4.9.6
* @deprecated 5.8.0 Use {@see 'user_erasure_fulfillment_email_content'} instead.
@@ -4553,9 +4554,9 @@ All at ###SITENAME###
*
* The following strings have a special meaning and will get replaced dynamically:
*
* ###SITENAME### The name of the site.
* ###PRIVACY_POLICY_URL### Privacy policy page URL.
* ###SITEURL### The URL to the site.
* - `###SITENAME###` The name of the site.
* - `###PRIVACY_POLICY_URL###` Privacy policy page URL.
* - `###SITEURL###` The URL to the site.
*
* @since 5.8.0
*
@@ -4873,10 +4874,10 @@ All at ###SITENAME###
*
* The following strings have a special meaning and will get replaced dynamically:
*
* ###DESCRIPTION### Description of the action being performed so the user knows what the email is for.
* ###CONFIRM_URL### The link to click on to confirm the account action.
* ###SITENAME### The name of the site.
* ###SITEURL### The URL to the site.
* - `###DESCRIPTION###` Description of the action being performed so the user knows what the email is for.
* - `###CONFIRM_URL###` The link to click on to confirm the account action.
* - `###SITENAME###` The name of the site.
* - `###SITEURL###` The URL to the site.
*
* @since 4.9.6
*

2
wp-includes/version.php
View File

@@ -16,7 +16,7 @@
*
* @global string $wp_version
*/
$wp_version = '6.9-alpha-60177';
$wp_version = '6.9-alpha-60178';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.