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

trunk/src/wp-admin/includes/privacy-tools.php

@@ -614 +614 @@
     /**
      * 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
@@ -679 +679 @@
      *
      * 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