Make WordPress Core


Ignore:
Timestamp:
10/17/2026 04:58:15 AM (34 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:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/class-wp-theme-json.php

    r64340 r64436  
    15841584                 * comma token. The exception are syntax errors, which are not handled here.
    15851585                 *
    1586                  * @see https://www.w3.org/TR/css-syntax-3/#parse-comma-separated-list-of-component-values
     1586                 * @link https://www.w3.org/TR/css-syntax-3/#parse-comma-separated-list-of-component-values
    15871587                 */
    15881588                if ( strlen( $selector ) === strcspn( $selector, '/\'"(<\\' ) ) {
    … …  
    16331633                 * comma token. The exception are syntax errors, which are not handled here.
    16341634                 *
    1635                  * @see https://www.w3.org/TR/css-syntax-3/#parse-comma-separated-list-of-component-values
     1635                 * @link https://www.w3.org/TR/css-syntax-3/#parse-comma-separated-list-of-component-values
    16361636                 */
    16371637                if ( strlen( $selector ) === strcspn( $selector, '/\'"(<\\' ) ) {
    … …  
    16781678         *     array( '.a /* a, the first *\/', '.b' ) === self::split_selector_list( '.a /* a, the first *\/,.b' );
    16791679         *
    1680          * @see https://www.w3.org/TR/selectors/#parse-selector
    1681          * @see https://www.w3.org/TR/css-syntax-3/
     1680         * @link https://www.w3.org/TR/selectors/#parse-selector
     1681         * @link https://www.w3.org/TR/css-syntax-3/
    16821682         *
    16831683         * @since 7.1.0
    … …  
    17861786                                 * > to U+000A LINE FEED during preprocessing.
    17871787                                 *
    1788                                  * @see https://www.w3.org/TR/css-syntax/#whitespace
    1789                                  * @see https://www.w3.org/TR/css-syntax/#newline
     1788                                 * @link https://www.w3.org/TR/css-syntax/#whitespace
     1789                                 * @link https://www.w3.org/TR/css-syntax/#newline
    17901790                                 */
    17911791                                $selectors[] = trim( substr( $selector, $was_at, $next_at - $was_at ), " \t\n" );
Note: See TracChangeset for help on using the changeset viewer.