Changeset 60178 for trunk/src/wp-includes/ms-functions.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-includes/ms-functions.php (modified) (2 diffs)

trunk/src/wp-includes/ms-functions.php

@@ -2817 +2817 @@
      *
      * 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
@@ -2928 +2929 @@
      *     @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.
      * }