diff --git a/src/wp-includes/html-api/class-wp-html-active-formatting-elements.php b/src/wp-includes/html-api/class-wp-html-active-formatting-elements.php index 2f51482eee052..90c3bbbd34e3b 100644 --- a/src/wp-includes/html-api/class-wp-html-active-formatting-elements.php +++ b/src/wp-includes/html-api/class-wp-html-active-formatting-elements.php @@ -29,6 +29,7 @@ * @since 6.4.0 * * @access private + * @ignore * * @see https://html.spec.whatwg.org/#list-of-active-formatting-elements * @see WP_HTML_Processor diff --git a/src/wp-includes/html-api/class-wp-html-attribute-token.php b/src/wp-includes/html-api/class-wp-html-attribute-token.php index 74d41320b1c79..fab66d827b451 100644 --- a/src/wp-includes/html-api/class-wp-html-attribute-token.php +++ b/src/wp-includes/html-api/class-wp-html-attribute-token.php @@ -14,6 +14,8 @@ * This class is for internal usage of the WP_HTML_Tag_Processor class. * * @access private + * @ignore + * * @since 6.2.0 * @since 6.5.0 Replaced `end` with `length` to more closely match `substr()`. * diff --git a/src/wp-includes/html-api/class-wp-html-open-elements.php b/src/wp-includes/html-api/class-wp-html-open-elements.php index aee5dccfb0c83..e17f901c4db6d 100644 --- a/src/wp-includes/html-api/class-wp-html-open-elements.php +++ b/src/wp-includes/html-api/class-wp-html-open-elements.php @@ -23,6 +23,7 @@ * @since 6.4.0 * * @access private + * @ignore * * @see https://html.spec.whatwg.org/#stack-of-open-elements * @see WP_HTML_Processor diff --git a/src/wp-includes/html-api/class-wp-html-processor-state.php b/src/wp-includes/html-api/class-wp-html-processor-state.php index b257aa809da75..c7c63286e1ebf 100644 --- a/src/wp-includes/html-api/class-wp-html-processor-state.php +++ b/src/wp-includes/html-api/class-wp-html-processor-state.php @@ -16,6 +16,7 @@ * @since 6.4.0 * * @access private + * @ignore * * @see WP_HTML_Processor */ diff --git a/src/wp-includes/html-api/class-wp-html-processor.php b/src/wp-includes/html-api/class-wp-html-processor.php index 8a6335378781a..5ba08a6bc1c57 100644 --- a/src/wp-includes/html-api/class-wp-html-processor.php +++ b/src/wp-includes/html-api/class-wp-html-processor.php @@ -582,6 +582,7 @@ private function create_fragment_at_current_node( string $html ) { * @throws WP_HTML_Unsupported_Exception Halts execution of the parser. * * @since 6.7.0 + * @ignore * * @param string $message Explains support is missing in order to parse the current node. * @return never @@ -790,8 +791,7 @@ public function next_token(): bool { * calls the {@see WP_HTML_Tag_Processor::base_class_next_token()} method. * * @since 6.7.2 Added for internal support. - * - * @access private + * @ignore * * @return bool */ @@ -880,6 +880,7 @@ public function is_tag_closer(): bool { * while processing HTML, rather than a token found in the HTML text itself. * * @since 6.6.0 + * @ignore * * @return bool Whether the current token is virtual. */ @@ -1472,6 +1473,7 @@ public function serialize_token(): string { * logic for the generalized WP_HTML_Processor::step() function. * * @since 6.7.0 + * @ignore * * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input. * @@ -1543,6 +1545,7 @@ private function step_initial(): bool { * logic for the generalized WP_HTML_Processor::step() function. * * @since 6.7.0 + * @ignore * * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input. * @@ -1640,6 +1643,7 @@ private function step_before_html(): bool { * logic for the generalized WP_HTML_Processor::step() function. * * @since 6.7.0 Stub implementation. + * @ignore * * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input. * @@ -1737,6 +1741,7 @@ private function step_before_head(): bool { * logic for the generalized WP_HTML_Processor::step() function. * * @since 6.7.0 + * @ignore * * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input. * @@ -1959,6 +1964,7 @@ private function step_in_head(): bool { * logic for the generalized WP_HTML_Processor::step() function. * * @since 6.7.0 Stub implementation. + * @ignore * * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input. * @@ -2062,6 +2068,7 @@ private function step_in_head_noscript(): bool { * logic for the generalized WP_HTML_Processor::step() function. * * @since 6.7.0 Stub implementation. + * @ignore * * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input. * @@ -2206,6 +2213,7 @@ private function step_after_head(): bool { * logic for the generalized WP_HTML_Processor::step() function. * * @since 6.4.0 + * @ignore * * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input. * @@ -3231,6 +3239,7 @@ private function step_in_body(): bool { * logic for the generalized WP_HTML_Processor::step() function. * * @since 6.7.0 + * @ignore * * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input. * @@ -3487,6 +3496,7 @@ private function step_in_table(): bool { * logic for the generalized WP_HTML_Processor::step() function. * * @since 6.7.0 Stub implementation. + * @ignore * * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input. * @@ -3506,6 +3516,7 @@ private function step_in_table_text(): bool { * logic for the generalized WP_HTML_Processor::step() function. * * @since 6.7.0 + * @ignore * * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input. * @@ -3590,6 +3601,7 @@ private function step_in_caption(): bool { * logic for the generalized WP_HTML_Processor::step() function. * * @since 6.7.0 + * @ignore * * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input. * @@ -3697,6 +3709,7 @@ private function step_in_column_group(): bool { * logic for the generalized WP_HTML_Processor::step() function. * * @since 6.7.0 + * @ignore * * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input. * @@ -3800,6 +3813,7 @@ private function step_in_table_body(): bool { * logic for the generalized WP_HTML_Processor::step() function. * * @since 6.7.0 + * @ignore * * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input. * @@ -3910,6 +3924,7 @@ private function step_in_row(): bool { * logic for the generalized WP_HTML_Processor::step() function. * * @since 6.7.0 + * @ignore * * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input. * @@ -4014,6 +4029,7 @@ private function step_in_cell(): bool { * logic for the generalized WP_HTML_Processor::step() function. * * @since 6.7.0 + * @ignore * * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input. * @@ -4189,6 +4205,7 @@ private function step_in_select(): bool { * logic for the generalized WP_HTML_Processor::step() function. * * @since 6.7.0 + * @ignore * * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input. * @@ -4253,6 +4270,7 @@ private function step_in_select_in_table(): bool { * logic for the generalized WP_HTML_Processor::step() function. * * @since 6.7.0 Stub implementation. + * @ignore * * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input. * @@ -4382,6 +4400,7 @@ private function step_in_template(): bool { * logic for the generalized WP_HTML_Processor::step() function. * * @since 6.7.0 Stub implementation. + * @ignore * * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input. * @@ -4471,6 +4490,7 @@ private function step_after_body(): bool { * logic for the generalized WP_HTML_Processor::step() function. * * @since 6.7.0 Stub implementation. + * @ignore * * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input. * @@ -4590,6 +4610,7 @@ private function step_in_frameset(): bool { * logic for the generalized WP_HTML_Processor::step() function. * * @since 6.7.0 Stub implementation. + * @ignore * * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input. * @@ -4675,6 +4696,7 @@ private function step_after_frameset(): bool { * logic for the generalized WP_HTML_Processor::step() function. * * @since 6.7.0 Stub implementation. + * @ignore * * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input. * @@ -4738,6 +4760,7 @@ private function step_after_after_body(): bool { * logic for the generalized WP_HTML_Processor::step() function. * * @since 6.7.0 Stub implementation. + * @ignore * * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input. * @@ -4806,6 +4829,7 @@ private function step_after_after_frameset(): bool { * logic for the generalized WP_HTML_Processor::step() function. * * @since 6.7.0 Stub implementation. + * @ignore * * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input. * @@ -5127,6 +5151,7 @@ private function step_in_foreign_content(): bool { * * @since 6.4.0 * @since 6.5.0 Renamed from bookmark_tag() to bookmark_token(). + * @ignore * * @throws Exception When unable to allocate requested bookmark. * @@ -5780,6 +5805,7 @@ public function has_bookmark( $bookmark_name ): bool { * Closes a P element. * * @since 6.4.0 + * @ignore * * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input. * @@ -5795,6 +5821,7 @@ private function close_a_p_element(): void { * * @since 6.4.0 * @since 6.7.0 Full spec support. + * @ignore * * @see https://html.spec.whatwg.org/#generate-implied-end-tags * @@ -5832,6 +5859,7 @@ private function generate_implied_end_tags( ?string $except_for_this_element = n * * @since 6.4.0 * @since 6.7.0 Full spec support. + * @ignore * * @see WP_HTML_Processor::generate_implied_end_tags * @see https://html.spec.whatwg.org/#generate-implied-end-tags @@ -5874,6 +5902,7 @@ private function generate_implied_end_tags_thoroughly(): void { * @see https://html.spec.whatwg.org/#adjusted-current-node * * @since 6.7.0 + * @ignore * * @return WP_HTML_Token|null The adjusted current node. */ @@ -5893,6 +5922,7 @@ private function get_adjusted_current_node(): ?WP_HTML_Token { * > been explicitly closed. * * @since 6.4.0 + * @ignore * * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input. * @@ -5935,6 +5965,7 @@ private function reconstruct_active_formatting_elements(): bool { * Runs the reset the insertion mode appropriately algorithm. * * @since 6.7.0 + * @ignore * * @see https://html.spec.whatwg.org/multipage/parsing.html#reset-the-insertion-mode-appropriately */ @@ -6127,6 +6158,7 @@ private function reset_insertion_mode_appropriately(): void { * Runs the adoption agency algorithm. * * @since 6.4.0 + * @ignore * * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input. * @@ -6244,6 +6276,7 @@ private function run_adoption_agency_algorithm(): void { * @see https://html.spec.whatwg.org/multipage/parsing.html#close-the-cell * * @since 6.7.0 + * @ignore */ private function close_cell(): void { $this->generate_implied_end_tags(); @@ -6262,6 +6295,7 @@ private function close_cell(): void { * Inserts an HTML element on the stack of open elements. * * @since 6.4.0 + * @ignore * * @see https://html.spec.whatwg.org/#insert-a-foreign-element * @@ -6275,6 +6309,7 @@ private function insert_html_element( WP_HTML_Token $token ): void { * Inserts a foreign element on to the stack of open elements. * * @since 6.7.0 + * @ignore * * @see https://html.spec.whatwg.org/#insert-a-foreign-element * @@ -6314,6 +6349,7 @@ private function insert_foreign_element( WP_HTML_Token $token, bool $only_add_to * Inserts a virtual element on the stack of open elements. * * @since 6.7.0 + * @ignore * * @param string $token_name Name of token to create and insert into the stack of open elements. * @param string|null $bookmark_name Optional. Name to give bookmark for created virtual node. @@ -6339,6 +6375,7 @@ private function insert_virtual_node( $token_name, $bookmark_name = null ): WP_H * Indicates if the current token is a MathML integration point. * * @since 6.7.0 + * @ignore * * @see https://html.spec.whatwg.org/#mathml-text-integration-point * @@ -6375,6 +6412,7 @@ private function is_mathml_integration_point(): bool { * no other accounting is overlooked. * * @since 6.7.0 + * @ignore * * @see https://html.spec.whatwg.org/#html-integration-point * diff --git a/src/wp-includes/html-api/class-wp-html-stack-event.php b/src/wp-includes/html-api/class-wp-html-stack-event.php index dcb3c79ef1003..acc000cd72930 100644 --- a/src/wp-includes/html-api/class-wp-html-stack-event.php +++ b/src/wp-includes/html-api/class-wp-html-stack-event.php @@ -13,6 +13,8 @@ * This class is for internal usage of the WP_HTML_Processor class. * * @access private + * @ignore + * * @since 6.6.0 * * @see WP_HTML_Processor diff --git a/src/wp-includes/html-api/class-wp-html-tag-processor.php b/src/wp-includes/html-api/class-wp-html-tag-processor.php index 69e3e5d2c7557..7adda266fc9b4 100644 --- a/src/wp-includes/html-api/class-wp-html-tag-processor.php +++ b/src/wp-includes/html-api/class-wp-html-tag-processor.php @@ -945,8 +945,7 @@ public function next_token(): bool { * applying patches before searching for the next token. * * @since 6.5.0 - * - * @access private + * @ignore * * @return bool Whether a token was parsed. */ @@ -1382,6 +1381,7 @@ public function release_bookmark( $name ): bool { * Skips contents of generic rawtext elements. * * @since 6.3.2 + * @ignore * * @see https://html.spec.whatwg.org/#generic-raw-text-element-parsing-algorithm * @@ -1401,6 +1401,7 @@ private function skip_rawtext( string $tag_name ): bool { * Skips contents of RCDATA elements, namely title and textarea tags. * * @since 6.2.0 + * @ignore * * @see https://html.spec.whatwg.org/multipage/parsing.html#rcdata-state * @@ -1492,6 +1493,7 @@ private function skip_rcdata( string $tag_name ): bool { * Skips contents of script tags. * * @since 6.2.0 + * @ignore * * @return bool Whether the script tag was closed before the end of the document. */ @@ -1701,6 +1703,7 @@ private function skip_script_data(): bool { * * @since 6.2.0 * @since 6.2.1 Support abruptly-closed comments, invalid-tag-closer-comments, and empty elements. + * @ignore * * @return bool Whether a tag was found before the end of the document. */ @@ -2122,6 +2125,7 @@ private function parse_next_tag(): bool { * Parses the next attribute. * * @since 6.2.0 + * @ignore * * @return bool Whether an attribute was found before the end of the document. */ @@ -2259,6 +2263,7 @@ private function parse_next_attribute(): bool { * Move the internal cursor past any immediate successive whitespace. * * @since 6.2.0 + * @ignore */ private function skip_whitespace(): void { $this->bytes_already_parsed += strspn( $this->html, " \t\f\r\n", $this->bytes_already_parsed ); @@ -2268,6 +2273,7 @@ private function skip_whitespace(): void { * Applies attribute updates and cleans up once a tag is fully parsed. * * @since 6.2.0 + * @ignore */ private function after_tag(): void { /* @@ -2327,6 +2333,7 @@ private function after_tag(): void { * (they are accumulated in different data formats for performance). * * @since 6.2.0 + * @ignore * * @see WP_HTML_Tag_Processor::$lexical_updates * @see WP_HTML_Tag_Processor::$classname_updates @@ -2490,6 +2497,7 @@ private function class_name_updates_to_attributes_updates(): void { * @since 6.2.0 * @since 6.2.1 Accumulates shift for internal cursor and passed pointer. * @since 6.3.0 Invalidate any bookmarks whose targets are overwritten. + * @ignore * * @param int $shift_this_point Accumulate and return shift for this position. * @return int How many bytes the given pointer moved in response to the updates. @@ -2647,6 +2655,7 @@ public function seek( $bookmark_name ): bool { * Compare two WP_HTML_Text_Replacement objects. * * @since 6.2.0 + * @ignore * * @param WP_HTML_Text_Replacement $a First attribute update. * @param WP_HTML_Text_Replacement $b Second attribute update. @@ -2680,6 +2689,7 @@ private static function sort_start_ascending( WP_HTML_Text_Replacement $a, WP_HT * - If no updates are enqueued, the return will be `false` to differentiate from "removed." * * @since 6.2.0 + * @ignore * * @param string $comparable_name The attribute name in its comparable form. * @return string|boolean|null Value of enqueued update if present, otherwise false. @@ -3915,6 +3925,7 @@ static function ( $tag_match ) { * @see https://html.spec.whatwg.org/multipage/scripting.html#prepare-the-script-element * * @since 7.0.0 + * @ignore * * @return 'javascript'|'json'|null Type of script element content if matched and recognized. */ @@ -4188,6 +4199,7 @@ private function get_script_content_type(): ?string { * @see wp_html_api_script_element_escaping_diagram_source() * * @since 7.0.0 + * @ignore * * @param string $sourcecode Raw contents intended to be serialized into an HTML SCRIPT element. * @return string Escaped form of input contents which will not lead to premature closing of the containing SCRIPT element. @@ -4653,6 +4665,7 @@ public function get_updated_html(): string { * Parses tag query input into internal search criteria. * * @since 6.2.0 + * @ignore * * @param array|string|null $query { * Optional. Which tag name to find, having which class, etc. Default is to find any tag. @@ -4719,6 +4732,7 @@ private function parse_query( $query ) { * Checks whether a given tag and its attributes match the search criteria. * * @since 6.2.0 + * @ignore * * @return bool Whether the given tag and its attribute match the search criteria. */