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

Compatibility

Present in every tracked release (6.7.10 to 7.1.3), 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–165

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

23

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

What one call costs · 49 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 · 33

• 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_Token::__construct()Constructor - creates a reference to a token in some external HTML string.
• WP_HTML_Processor::bookmark_token()Creates a new bookmark for the currently-matched token and returns the generated name.
• 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 · 23

• 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.
• WP_HTML_Processor::step_in_column_group()Parses next element in the 'in column group' insertion mode.

Source code

View on Trac ↗View on GitHub ↗

983	public function step( $node_to_process = self::PROCESS_NEXT_NODE ): bool {984		// Refuse to proceed if there was a previous error.985		if ( null !== $this->last_error ) {986			return false;987		}988 989		if ( self::REPROCESS_CURRENT_NODE !== $node_to_process ) {990			/*991			 * Void elements still hop onto the stack of open elements even though992			 * there's no corresponding closing tag. This is important for managing993			 * stack-based operations such as "navigate to parent node" or checking994			 * on an element's breadcrumbs.995			 *996			 * When moving on to the next node, therefore, if the bottom-most element997			 * on the stack is a void element, it must be closed.998			 */999			$top_node = $this->state->stack_of_open_elements->current_node();1000			if ( isset( $top_node ) && ! $this->expects_closer( $top_node ) ) {1001				$this->state->stack_of_open_elements->pop();1002			}1003		}1004 1005		if ( self::PROCESS_NEXT_NODE === $node_to_process ) {1006			parent::next_token();1007			if ( WP_HTML_Tag_Processor::STATE_TEXT_NODE === $this->parser_state ) {1008				parent::subdivide_text_appropriately();1009			}1010		}1011 1012		// Finish stepping when there are no more tokens in the document.1013		if (1014			WP_HTML_Tag_Processor::STATE_INCOMPLETE_INPUT === $this->parser_state ||1015			WP_HTML_Tag_Processor::STATE_COMPLETE === $this->parser_state1016		) {1017			return false;1018		}1019 1020		$adjusted_current_node = $this->get_adjusted_current_node();1021		$is_closer             = $this->is_tag_closer();1022		$is_start_tag          = WP_HTML_Tag_Processor::STATE_MATCHED_TAG === $this->parser_state && ! $is_closer;1023		$token_name            = $this->get_token_name();1024 1025		if ( self::REPROCESS_CURRENT_NODE !== $node_to_process ) {1026			$this->state->current_token = new WP_HTML_Token(1027				$this->bookmark_token(),1028				$token_name,1029				$this->has_self_closing_flag(),1030				$this->release_internal_bookmark_on_destruct1031			);1032		}1033 1034		$parse_in_current_insertion_mode = (1035			0 === $this->state->stack_of_open_elements->count() ||1036			'html' === $adjusted_current_node->namespace ||1037			(1038				'math' === $adjusted_current_node->integration_node_type &&1039				(1040					( $is_start_tag && ! in_array( $token_name, array( 'MGLYPH', 'MALIGNMARK' ), true ) ) ||1041					'#text' === $token_name1042				)1043			) ||1044			(1045				'math' === $adjusted_current_node->namespace &&1046				'ANNOTATION-XML' === $adjusted_current_node->node_name &&1047				$is_start_tag && 'SVG' === $token_name1048			) ||1049			(1050				'html' === $adjusted_current_node->integration_node_type &&1051				( $is_start_tag || '#text' === $token_name )1052			)1053		);1054 1055		try {1056			if ( ! $parse_in_current_insertion_mode ) {1057				return $this->step_in_foreign_content();1058			}1059 1060			switch ( $this->state->insertion_mode ) {1061				case WP_HTML_Processor_State::INSERTION_MODE_INITIAL:1062					return $this->step_initial();

Changelog

Introduced in 6.4.0. Unchanged from 6.7.10 through 7.1.3.

1. 6.7.10
2. 6.8.11
3. 6.9.10
4. 7.0.7
5. 7.1.3

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

About this page

Parsed data

Generated from the wordpress-develop 6.8.11 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.