Changeset 64436 for trunk/src/wp-includes/deprecated.php

Timestamp:

10/17/2026 04:58:15 AM (22 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/deprecated.php (modified) (2 diffs)

trunk/src/wp-includes/deprecated.php

@@ -6385 +6385 @@
          * settings depending on user permissions, etc.).
          * See some of the existing hooks to modify theme.json behavior:
-         * @see https://make.wordpress.org/core/2022/10/10/filters-for-theme-json-data/
+         * @link https://make.wordpress.org/core/2022/10/10/filters-for-theme-json-data/
          *
          * A different alternative considered was to invalidate the cache upon certain
          * events such as options add/update/delete, user meta, etc.
          * It was judged not enough, hence this approach.
-         * @see https://github.com/WordPress/gutenberg/pull/45372
+         * @link https://github.com/WordPress/gutenberg/pull/45372
          */
         $cache_key   = 'wp_get_global_styles_custom_css';
@@ -6518 +6518 @@
  * @see wp_enqueue_img_auto_sizes_contain_css_fix()
  *
- * @see https://html.spec.whatwg.org/multipage/rendering.html#img-contain-size
- * @see https://core.trac.wordpress.org/ticket/62413
- * @see https://core.trac.wordpress.org/ticket/62731
+ * @link https://html.spec.whatwg.org/multipage/rendering.html#img-contain-size
+ * @link https://core.trac.wordpress.org/ticket/62413
+ * @link https://core.trac.wordpress.org/ticket/62731
  */
 function wp_print_auto_sizes_contain_css_fix() {