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

Timestamp:

10/17/2026 04:58:15 AM (5 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/script-loader.php (modified) (5 diffs)

trunk/src/wp-includes/script-loader.php

@@ -179 +179 @@
  * when using `wp-scripts start --hot`.
  *
- * @see https://github.com/WordPress/gutenberg/tree/trunk/packages/scripts#start
+ * @link https://github.com/WordPress/gutenberg/tree/trunk/packages/scripts#start
  *
  * @since 6.0.0
@@ -3052 +3052 @@
                  * Prefetches the page's rel=prefetch links with fetch() in browsers that do not support rel=prefetch.
                  *
-                 * @see https://caniuse.com/link-rel-prefetch
+                 * @link https://caniuse.com/link-rel-prefetch
                  */
                 () => {
@@ -4658 +4658 @@
  * @since 6.9.0
  *
- * @see https://html.spec.whatwg.org/#concept-domstringmap-pairs
  * @see \wp_html_custom_data_attribute_name()
+ * @link https://html.spec.whatwg.org/#concept-domstringmap-pairs
  *
  * @param string $html_attribute_name Raw attribute name as found in the source HTML.
@@ -4685 +4685 @@
          * > followed it by the same character converted to ASCII uppercase.
          *
-         * @see https://html.spec.whatwg.org/#concept-domstringmap-pairs
+         * @link https://html.spec.whatwg.org/#concept-domstringmap-pairs
          */
         $custom_name = '';
@@ -4736 +4736 @@
  * @since 6.9.0
  *
- * @see https://html.spec.whatwg.org/#concept-domstringmap-pairs
  * @see \wp_js_dataset_name()
+ * @link https://html.spec.whatwg.org/#concept-domstringmap-pairs
  *
  * @param string $js_dataset_name Name of JS `dataset` property to transform.