WP_HTML_Processor::step( string $node_to_process = self::PROCESS_NEXT_NODE ): bool

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$node_to_processstringoptional

Whether to parse the next node or reprocess the current node.Default: self::PROCESS_NEXT_NODE

Return value

bool

Whether a tag was matched.

Performance profile

How much work a call to WP_HTML_Processor::step() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

15–162

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 307.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

22

22 places in core call this, so the cost is paid more often than your own code shows.

What one call costs · 68 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_HTML_Processor::step() can have, taken from its control-flow graph on PHP 8.5.

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Uses · 31

• WP_HTML_Processor::expects_closer()Indicates if the currently-matched node expects a closing token, or if it will self-close on the next step.
• WP_HTML_Tag_Processor::next_token()Finds the next token in the HTML document.
• WP_HTML_Tag_Processor::subdivide_text_appropriately()Subdivides a matched text node, splitting NULL byte sequences and decoded whitespace as distinct nodes prefixes.
• WP_HTML_Processor::get_adjusted_current_node()Returns the adjusted current node.
• WP_HTML_Processor::is_tag_closer()Indicates if the current tag token is a tag closer.
• WP_HTML_Processor::get_token_name()Returns the node name represented by the token.
• WP_HTML_Processor::bookmark_token()Creates a new bookmark for the currently-matched token and returns the generated name.
• WP_HTML_Token::__construct()Constructor - creates a reference to a token in some external HTML string.
• WP_HTML_Processor::has_self_closing_flag()Indicates if the currently matched tag contains the self-closing flag.
• WP_HTML_Processor::step_in_foreign_content()Parses next element in the 'in foreign content' insertion mode.
• WP_HTML_Processor::step_initial()Parses next element in the 'initial' insertion mode.
• WP_HTML_Processor::step_before_html()Parses next element in the 'before html' insertion mode.

Used by · 22

• WP_HTML_Processor::in_body_any_other_end_tag()Applies the "any other end tag" parsing instructions for the IN BODY insertion mode.
• WP_HTML_Processor::next_visitable_token()Ensures internal accounting is maintained for HTML semantic rules while the underlying Tag Processor class is seeking to a bookmark.
• WP_HTML_Processor::step_after_after_body()Parses next element in the 'after after body' insertion mode.
• WP_HTML_Processor::step_after_after_frameset()Parses next element in the 'after after frameset' insertion mode.
• WP_HTML_Processor::step_after_body()Parses next element in the 'after body' insertion mode.
• WP_HTML_Processor::step_after_frameset()Parses next element in the 'after frameset' insertion mode.
• WP_HTML_Processor::step_after_head()Parses next element in the 'after head' insertion mode.
• WP_HTML_Processor::step_before_head()Parses next element in the 'before head' insertion mode.
• WP_HTML_Processor::step_before_html()Parses next element in the 'before html' insertion mode.
• WP_HTML_Processor::step_in_body()Parses next element in the 'in body' insertion mode.
• WP_HTML_Processor::step_in_caption()Parses next element in the 'in caption' insertion mode.
• WP_HTML_Processor::step_in_cell()Parses next element in the 'in cell' insertion mode.

Source code

View on Trac ↗View on GitHub ↗

1020	public function step( $node_to_process = self::PROCESS_NEXT_NODE ): bool {1021		// Refuse to proceed if there was a previous error.1022		if ( null !== $this->last_error ) {1023			return false;1024		}1025 1026		if ( self::REPROCESS_CURRENT_NODE !== $node_to_process ) {1027			/*1028			 * Void elements still hop onto the stack of open elements even though1029			 * there's no corresponding closing tag. This is important for managing1030			 * stack-based operations such as "navigate to parent node" or checking1031			 * on an element's breadcrumbs.1032			 *1033			 * When moving on to the next node, therefore, if the bottom-most element1034			 * on the stack is a void element, it must be closed.1035			 */1036			$top_node = $this->state->stack_of_open_elements->current_node();1037			if ( isset( $top_node ) && ! $this->expects_closer( $top_node ) ) {1038				$this->state->stack_of_open_elements->pop();1039			}1040		}1041 1042		if ( self::PROCESS_NEXT_NODE === $node_to_process ) {1043			parent::next_token();1044			if ( WP_HTML_Tag_Processor::STATE_TEXT_NODE === $this->parser_state ) {1045				parent::subdivide_text_appropriately();1046			}1047		}1048 1049		// Finish stepping when there are no more tokens in the document.1050		if (1051			WP_HTML_Tag_Processor::STATE_INCOMPLETE_INPUT === $this->parser_state ||1052			WP_HTML_Tag_Processor::STATE_COMPLETE === $this->parser_state1053		) {1054			return false;1055		}1056 1057		$adjusted_current_node = $this->get_adjusted_current_node();1058		$is_closer             = $this->is_tag_closer();1059		$is_start_tag          = WP_HTML_Tag_Processor::STATE_MATCHED_TAG === $this->parser_state && ! $is_closer;1060		$token_name            = $this->get_token_name();1061 1062		if ( self::REPROCESS_CURRENT_NODE !== $node_to_process ) {1063			try {1064				$bookmark_name = $this->bookmark_token();1065			} catch ( Exception $e ) {1066				if ( self::ERROR_EXCEEDED_MAX_BOOKMARKS === $this->last_error ) {1067					return false;1068				}1069				throw $e;1070			}1071 1072			$this->state->current_token = new WP_HTML_Token(1073				$bookmark_name,1074				$token_name,1075				$this->has_self_closing_flag(),1076				$this->release_internal_bookmark_on_destruct1077			);1078		}1079 1080		$parse_in_current_insertion_mode = (1081			0 === $this->state->stack_of_open_elements->count() ||1082			'html' === $adjusted_current_node->namespace ||1083			(1084				'math' === $adjusted_current_node->integration_node_type &&1085				(1086					( $is_start_tag && ! in_array( $token_name, array( 'MGLYPH', 'MALIGNMARK' ), true ) ) ||1087					'#text' === $token_name1088				)1089			) ||1090			(1091				'math' === $adjusted_current_node->namespace &&1092				'ANNOTATION-XML' === $adjusted_current_node->node_name &&1093				$is_start_tag && 'SVG' === $token_name1094			) ||1095			(1096				'html' === $adjusted_current_node->integration_node_type &&1097				( $is_start_tag || '#text' === $token_name )1098			)1099		);

Changelog

Introduced in 6.4.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/html-api/class-wp-html-processor.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.