Changeset 60178 for trunk/src/wp-admin/includes/misc.php

Timestamp:

04/21/2025 11:47:11 AM (9 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:

• trunk/src/wp-admin/includes/misc.php (modified) (1 diff)

trunk/src/wp-admin/includes/misc.php

@@ -1484 +1484 @@
      *
      * 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)