WordPress.org
Get WordPress

Make WordPress Core

Changeset 60249


Ignore:
Timestamp:
05/26/2025 11:18:03 AM (10 months ago)
Author:
johnbillion
Message:

Docs: Switch some @internal tags to the inline format so the corresponding function or method is not treated by IDEs and static scanning tools as internal use only.

See #63166

Location:
trunk/src/wp-includes
Files:
6 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-includes/comment-template.php

    r60166 r60249  
    20962096 * Only affects users with JavaScript disabled.
    20972097 *
    2098  * @internal The $comment global must be present to allow template tags access to the current
    2099  *           comment. See https://core.trac.wordpress.org/changeset/36512.
     2098 * {@internal The $comment global must be present to allow template tags access to the current
     2099 * comment. See https://core.trac.wordpress.org/changeset/36512.}
    21002100 *
    21012101 * @since 2.7.0

  • trunk/src/wp-includes/formatting.php

    r60227 r60249  
    25522552 * Balances tags of string using a modified stack.
    25532553 *
     2554 * {@internal Modified by Scott Reilly (coffee2code) 02 Aug 2004
     2555 *      1.1  Fixed handling of append/stack pop order of end text
     2556 *           Added Cleaning Hooks
     2557 *      1.0  First Version}
     2558 *
    25542559 * @since 2.0.4
    25552560 * @since 5.3.0 Improve accuracy and add support for custom element tags.
    … …  
    25602565 * @version 1.1
    25612566 * @todo Make better - change loop condition to $text in 1.2
    2562  * @internal Modified by Scott Reilly (coffee2code) 02 Aug 2004
    2563  *      1.1  Fixed handling of append/stack pop order of end text
    2564  *           Added Cleaning Hooks
    2565  *      1.0  First Version
    25662567 *
    25672568 * @param string $text Text to be balanced.

  • trunk/src/wp-includes/ms-load.php

    r57877 r60249  
    130130 * Retrieves the closest matching network for a domain and path.
    131131 *
     132 * {@internal In 4.4.0, converted to a wrapper for WP_Network::get_by_path()}
     133 *
    132134 * @since 3.9.0
    133  *
    134  * @internal In 4.4.0, converted to a wrapper for WP_Network::get_by_path()
    135135 *
    136136 * @param string   $domain   Domain to check.
    … …  
    553553 * Retrieves an object containing information about the requested network.
    554554 *
     555 * {@internal In 4.6.0, converted to use get_network()}
     556 *
    555557 * @since 3.9.0
    556558 * @deprecated 4.7.0 Use get_network()
    557559 * @see get_network()
    558560 *
    559  * @internal In 4.6.0, converted to use get_network()
    560  *
    561561 * @param object|int $network The network's database row or ID.
    562562 * @return WP_Network|false Object containing network information if found, false if not.

  • trunk/src/wp-includes/rest-api/class-wp-rest-response.php

    r54891 r60249  
    4444     * Adds a link to the response.
    4545     *
    46      * @internal The $rel parameter is first, as this looks nicer when sending multiple.
     46     * {@internal The $rel parameter is first, as this looks nicer when sending multiple.}
    4747     *
    4848     * @since 4.4.0
    … …  
    136136     * Sets a single link header.
    137137     *
    138      * @internal The $rel parameter is first, as this looks nicer when sending multiple.
     138     * {@internal The $rel parameter is first, as this looks nicer when sending multiple.}
    139139     *
    140140     * @since 4.4.0

  • trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-controller.php

    r56559 r60249  
    663663     * Sanitizes the slug value.
    664664     *
    665      * @since 4.7.0
    666      *
    667      * @internal We can't use sanitize_title() directly, as the second
     665     * {@internal We can't use sanitize_title() directly, as the second
    668666     * parameter is the fallback title, which would end up being set to the
    669      * request object.
     667     * request object.}
     668     *
     669     * @since 4.7.0
    670670     *
    671671     * @see https://github.com/WP-API/WP-API/issues/1585

  • trunk/src/wp-includes/taxonomy.php

    r59784 r60249  
    12931293 * Prior to 4.5.0, taxonomy was passed as the first parameter of `get_terms()`.
    12941294 *
     1295 * {@internal The `$deprecated` parameter is parsed for backward compatibility only.}
     1296 *
    12951297 * @since 2.3.0
    12961298 * @since 4.2.0 Introduced 'name' and 'childless' parameters.
    … …  
    13011303 *              Introduced 'meta_key' and 'meta_value' parameters. Introduced the ability to order results by metadata.
    13021304 * @since 4.8.0 Introduced 'suppress_filter' parameter.
    1303  *
    1304  * @internal The `$deprecated` parameter is parsed for backward compatibility only.
    13051305 *
    13061306 * @param array|string $args       Optional. Array or string of arguments. See WP_Term_Query::__construct()
    … …  
    19281928 * Default $args is 'hide_empty' which can be 'hide_empty=true' or array('hide_empty' => true).
    19291929 *
     1930 * {@internal The `$deprecated` parameter is parsed for backward compatibility only.}
     1931 *
    19301932 * @since 2.3.0
    19311933 * @since 5.6.0 Changed the function signature so that the `$args` array can be provided as the first parameter.
    1932  *
    1933  * @internal The `$deprecated` parameter is parsed for backward compatibility only.
    19341934 *
    19351935 * @param array|string $args       Optional. Array or string of arguments. See WP_Term_Query::__construct()
Note: See TracChangeset for help on using the changeset viewer.