Changeset 60178 for trunk/src/wp-includes/functions.php

Timestamp:

04/21/2025 11:47:11 AM (12 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-includes/functions.php (modified) (1 diff)

trunk/src/wp-includes/functions.php

@@ -8181 +8181 @@
      *     @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.
      * }