WordPress.org
Get WordPress

Make WordPress Core

Changeset 61793


Ignore:
Timestamp:
03/03/2026 01:10:51 PM (7 months ago)
Author:
jonsurrell
Message:

HTML API: Exclude internal classes and methods from documentation.

Add @ignore annotations to internal HTML API methods and classes to exclude them from generated documentation. The HTML API relies heavily on internal methods and classes and they create a lot of noise in documentation.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/11078.

Props jonsurrell, westonruter.
See #64224.

Location:
trunk/src/wp-includes/html-api
Files:
7 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-includes/html-api/class-wp-html-active-formatting-elements.php

    r58779 r61793  
    3030 *
    3131 * @access private
     32 * @ignore
    3233 *
    3334 * @see https://html.spec.whatwg.org/#list-of-active-formatting-elements

  • trunk/src/wp-includes/html-api/class-wp-html-attribute-token.php

    r57179 r61793  
    1515 *
    1616 * @access private
     17 * @ignore
     18 *
    1719 * @since 6.2.0
    1820 * @since 6.5.0 Replaced `end` with `length` to more closely match `substr()`.

  • trunk/src/wp-includes/html-api/class-wp-html-open-elements.php

    r61624 r61793  
    2424 *
    2525 * @access private
     26 * @ignore
    2627 *
    2728 * @see https://html.spec.whatwg.org/#stack-of-open-elements

  • trunk/src/wp-includes/html-api/class-wp-html-processor-state.php

    r59463 r61793  
    1717 *
    1818 * @access private
     19 * @ignore
    1920 *
    2021 * @see WP_HTML_Processor

  • trunk/src/wp-includes/html-api/class-wp-html-processor.php

    r61792 r61793  
    584584         *
    585585         * @since 6.7.0
     586         * @ignore
    586587         *
    587588         * @param string $message Explains support is missing in order to parse the current node.
    … …  
    792793         *
    793794         * @since 6.7.2 Added for internal support.
    794          *
    795          * @access private
     795         * @ignore
    796796         *
    797797         * @return bool
    … …  
    882882         *
    883883         * @since 6.6.0
     884         * @ignore
    884885         *
    885886         * @return bool Whether the current token is virtual.
    … …  
    14891490         *
    14901491         * @since 6.7.0
     1492         * @ignore
    14911493         *
    14921494         * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
    … …  
    15601562         *
    15611563         * @since 6.7.0
     1564         * @ignore
    15621565         *
    15631566         * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
    … …  
    16571660         *
    16581661         * @since 6.7.0
     1662         * @ignore
    16591663         *
    16601664         * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
    … …  
    17541758         *
    17551759         * @since 6.7.0
     1760         * @ignore
    17561761         *
    17571762         * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
    … …  
    19761981         *
    19771982         * @since 6.7.0
     1983         * @ignore
    19781984         *
    19791985         * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
    … …  
    20792085         *
    20802086         * @since 6.7.0
     2087         * @ignore
    20812088         *
    20822089         * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
    … …  
    22232230         *
    22242231         * @since 6.4.0
     2232         * @ignore
    22252233         *
    22262234         * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
    … …  
    32483256         *
    32493257         * @since 6.7.0
     3258         * @ignore
    32503259         *
    32513260         * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
    … …  
    35043513         *
    35053514         * @since 6.7.0 Stub implementation.
     3515         * @ignore
    35063516         *
    35073517         * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
    … …  
    35233533         *
    35243534         * @since 6.7.0
     3535         * @ignore
    35253536         *
    35263537         * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
    … …  
    36073618         *
    36083619         * @since 6.7.0
     3620         * @ignore
    36093621         *
    36103622         * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
    … …  
    37143726         *
    37153727         * @since 6.7.0
     3728         * @ignore
    37163729         *
    37173730         * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
    … …  
    38173830         *
    38183831         * @since 6.7.0
     3832         * @ignore
    38193833         *
    38203834         * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
    … …  
    39273941         *
    39283942         * @since 6.7.0
     3943         * @ignore
    39293944         *
    39303945         * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
    … …  
    40314046         *
    40324047         * @since 6.7.0
     4048         * @ignore
    40334049         *
    40344050         * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
    … …  
    42064222         *
    42074223         * @since 6.7.0
     4224         * @ignore
    42084225         *
    42094226         * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
    … …  
    42704287         *
    42714288         * @since 6.7.0
     4289         * @ignore
    42724290         *
    42734291         * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
    … …  
    43994417         *
    44004418         * @since 6.7.0
     4419         * @ignore
    44014420         *
    44024421         * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
    … …  
    44884507         *
    44894508         * @since 6.7.0
     4509         * @ignore
    44904510         *
    44914511         * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
    … …  
    46074627         *
    46084628         * @since 6.7.0
     4629         * @ignore
    46094630         *
    46104631         * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
    … …  
    46924713         *
    46934714         * @since 6.7.0
     4715         * @ignore
    46944716         *
    46954717         * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
    … …  
    47554777         *
    47564778         * @since 6.7.0
     4779         * @ignore
    47574780         *
    47584781         * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
    … …  
    48234846         *
    48244847         * @since 6.7.0
     4848         * @ignore
    48254849         *
    48264850         * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
    … …  
    51445168         * @since 6.4.0
    51455169         * @since 6.5.0 Renamed from bookmark_tag() to bookmark_token().
     5170         * @ignore
    51465171         *
    51475172         * @throws Exception When unable to allocate requested bookmark.
    … …  
    57975822         *
    57985823         * @since 6.4.0
     5824         * @ignore
    57995825         *
    58005826         * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
    … …  
    58125838         * @since 6.4.0
    58135839         * @since 6.7.0 Full spec support.
     5840         * @ignore
    58145841         *
    58155842         * @see https://html.spec.whatwg.org/#generate-implied-end-tags
    … …  
    58495876         * @since 6.4.0
    58505877         * @since 6.7.0 Full spec support.
     5878         * @ignore
    58515879         *
    58525880         * @see WP_HTML_Processor::generate_implied_end_tags
    … …  
    58915919         *
    58925920         * @since 6.7.0
     5921         * @ignore
    58935922         *
    58945923         * @return WP_HTML_Token|null The adjusted current node.
    … …  
    59105939         *
    59115940         * @since 6.4.0
     5941         * @ignore
    59125942         *
    59135943         * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
    … …  
    59525982         *
    59535983         * @since 6.7.0
     5984         * @ignore
    59545985         *
    59555986         * @see https://html.spec.whatwg.org/multipage/parsing.html#reset-the-insertion-mode-appropriately
    … …  
    61446175         *
    61456176         * @since 6.4.0
     6177         * @ignore
    61466178         *
    61476179         * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
    … …  
    62616293         *
    62626294         * @since 6.7.0
     6295         * @ignore
    62636296         */
    62646297        private function close_cell(): void {
    … …  
    62796312         *
    62806313         * @since 6.4.0
     6314         * @ignore
    62816315         *
    62826316         * @see https://html.spec.whatwg.org/#insert-a-foreign-element
    … …  
    62926326         *
    62936327         * @since 6.7.0
     6328         * @ignore
    62946329         *
    62956330         * @see https://html.spec.whatwg.org/#insert-a-foreign-element
    … …  
    63316366         *
    63326367         * @since 6.7.0
     6368         * @ignore
    63336369         *
    63346370         * @throws Exception When unable to allocate a bookmark for the next token in the input HTML document.
    … …  
    63586394         *
    63596395         * @since 6.7.0
     6396         * @ignore
    63606397         *
    63616398         * @see https://html.spec.whatwg.org/#mathml-text-integration-point
    … …  
    63946431         *
    63956432         * @since 6.7.0
     6433         * @ignore
    63966434         *
    63976435         * @see https://html.spec.whatwg.org/#html-integration-point

  • trunk/src/wp-includes/html-api/class-wp-html-stack-event.php

    r58769 r61793  
    1414 *
    1515 * @access private
     16 * @ignore
     17 *
    1618 * @since 6.6.0
    1719 *

  • trunk/src/wp-includes/html-api/class-wp-html-tag-processor.php

    r61754 r61793  
    946946         *
    947947         * @since 6.5.0
    948          *
    949          * @access private
     948         * @ignore
    950949         *
    951950         * @return bool Whether a token was parsed.
    … …  
    13831382         *
    13841383         * @since 6.3.2
     1384         * @ignore
    13851385         *
    13861386         * @see https://html.spec.whatwg.org/#generic-raw-text-element-parsing-algorithm
    … …  
    14021402         *
    14031403         * @since 6.2.0
     1404         * @ignore
    14041405         *
    14051406         * @see https://html.spec.whatwg.org/multipage/parsing.html#rcdata-state
    … …  
    14931494         *
    14941495         * @since 6.2.0
     1496         * @ignore
    14951497         *
    14961498         * @return bool Whether the script tag was closed before the end of the document.
    … …  
    17021704         * @since 6.2.0
    17031705         * @since 6.2.1 Support abruptly-closed comments, invalid-tag-closer-comments, and empty elements.
     1706         * @ignore
    17041707         *
    17051708         * @return bool Whether a tag was found before the end of the document.
    … …  
    21232126         *
    21242127         * @since 6.2.0
     2128         * @ignore
    21252129         *
    21262130         * @return bool Whether an attribute was found before the end of the document.
    … …  
    22602264         *
    22612265         * @since 6.2.0
     2266         * @ignore
    22622267         */
    22632268        private function skip_whitespace(): void {
    … …  
    22692274         *
    22702275         * @since 6.2.0
     2276         * @ignore
    22712277         */
    22722278        private function after_tag(): void {
    … …  
    23282334         *
    23292335         * @since 6.2.0
     2336         * @ignore
    23302337         *
    23312338         * @see WP_HTML_Tag_Processor::$lexical_updates
    … …  
    24912498         * @since 6.2.1 Accumulates shift for internal cursor and passed pointer.
    24922499         * @since 6.3.0 Invalidate any bookmarks whose targets are overwritten.
     2500         * @ignore
    24932501         *
    24942502         * @param int $shift_this_point Accumulate and return shift for this position.
    … …  
    26482656         *
    26492657         * @since 6.2.0
     2658         * @ignore
    26502659         *
    26512660         * @param WP_HTML_Text_Replacement $a First attribute update.
    … …  
    26812690         *
    26822691         * @since 6.2.0
     2692         * @ignore
    26832693         *
    26842694         * @param string $comparable_name The attribute name in its comparable form.
    … …  
    39273937         *
    39283938         * @since 7.0.0
     3939         * @ignore
    39293940         *
    39303941         * @return 'javascript'|'json'|null Type of script element content if matched and recognized.
    … …  
    42004211         *
    42014212         * @since 7.0.0
     4213         * @ignore
    42024214         *
    42034215         * @param string $sourcecode Raw contents intended to be serialized into an HTML SCRIPT element.
    … …  
    46654677         *
    46664678         * @since 6.2.0
     4679         * @ignore
    46674680         *
    46684681         * @param array|string|null $query {
    … …  
    47314744         *
    47324745         * @since 6.2.0
     4746         * @ignore
    47334747         *
    47344748         * @return bool Whether the given tag and its attribute match the search criteria.
Note: See TracChangeset for help on using the changeset viewer.