Changeset 64436 for trunk/src/wp-includes/class-wp-script-modules.php

Timestamp:

10/17/2026 04:58:15 AM (4 hours ago)

Author:

westonruter

Message:

Docs: Use @link instead of @see for URL references.

The WordPress inline documentation standards for PHP and JavaScript reserve @see for references to functions, methods, classes, and hooks, and use @link for URLs. While phpDocumentor and JSDoc both accept a URL in @see, core had used both forms for external references such as specifications, Trac tickets, and GitHub pull requests, so the remaining @see tags pointing to URLs are converted to @link across core, the bundled themes, core scripts, and the unit tests.

On the touched lines, @see is kept ahead of @link where both appear, per the standards; links to developer.wordpress.org pages for core functions in Twenty Twenty become @see references to those functions; and links that no longer resolve are updated. The block files synced from Gutenberg, the bundled pomo library, and other third-party code are left unchanged, and the HTML API is handled separately.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/10804.
Follow-up to r63569.

Props huzaifaalmesbah, westonruter, noruzzaman, shailu25.
See #65860.

File:

• trunk/src/wp-includes/class-wp-script-modules.php (modified) (1 diff)

trunk/src/wp-includes/class-wp-script-modules.php

@@ -1103 +1103 @@
                                  * be escaped to avoid encoding issues.
                                  *
-                                 * @see https://www.rfc-editor.org/rfc/rfc8259.html for details on encoding requirements.
-                                 * @see https://www.php.net/manual/en/json.constants.php for details on these constants.
-                                 * @see https://html.spec.whatwg.org/#script-data-state for details on script tag parsing.
+                                 * @link https://www.rfc-editor.org/rfc/rfc8259.html for details on encoding requirements.
+                                 * @link https://www.php.net/manual/en/json.constants.php for details on these constants.
+                                 * @link https://html.spec.whatwg.org/#script-data-state for details on script tag parsing.
                                  */
                                 $json_encode_flags = JSON_HEX_TAG | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_LINE_TERMINATORS;