WP_HTML_Processor::create_fragment_at_current_node( string $html ): static|null

Description

└─#text Inside TD?

├─svg:td
└─#text Inside TD?

└─TBODY
 └─TR
 └─TD
 └─#text Inside TD?

Compatibility

Present in 4 of the 5 tracked releases, added in 6.8.0, and compiles on PHP 7.4 through 8.6-dev.

Parameters

$htmlstring

Input HTML fragment to process.

Return value

static|null

The created processor if successful, otherwise null.

Performance profile

How much work a call to WP_HTML_Processor::create_fragment_at_current_node() 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

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

14–124

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksdo_action()one call below WP_HTML_Processor::create_fragment_at_current_node()

Further down the call graph this can also reach query, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 6 distinct outcomes

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

Uses · 8

• _doing_it_wrong()Marks something as being incorrectly called.
• __()Retrieves the translation of $text.
• WP_HTML_Processor::get_token_type()Indicates the kind of matched token, if any.
• WP_HTML_Processor::is_tag_closer()Indicates if the current tag token is a tag closer.
• WP_HTML_Processor::is_void()Returns whether a given element is an HTML Void Element
• static::__construct()
• WP_HTML_Span::__construct()Constructor.
• WP_HTML_Token::__construct()Constructor - creates a reference to a token in some external HTML string.

Source code

View on Trac ↗View on GitHub ↗

484	private function create_fragment_at_current_node( string $html ) {485		if ( $this->get_token_type() !== '#tag' || $this->is_tag_closer() ) {486			_doing_it_wrong(487				__METHOD__,488				__( 'The context element must be a start tag.' ),489				'6.8.0'490			);491			return null;492		}493 494		$tag_name  = $this->current_element->token->node_name;495		$namespace = $this->current_element->token->namespace;496 497		if ( 'html' === $namespace && self::is_void( $tag_name ) ) {498			_doing_it_wrong(499				__METHOD__,500				sprintf(501					// translators: %s: A tag name like INPUT or BR.502					__( 'The context element cannot be a void element, found "%s".' ),503					$tag_name504				),505				'6.8.0'506			);507			return null;508		}509 510		/*511		 * Prevent creating fragments at nodes that require a special tokenizer state.512		 * This is unsupported by the HTML Processor.513		 */514		if (515			'html' === $namespace &&516			in_array( $tag_name, array( 'IFRAME', 'NOEMBED', 'NOFRAMES', 'SCRIPT', 'STYLE', 'TEXTAREA', 'TITLE', 'XMP', 'PLAINTEXT' ), true )517		) {518			_doing_it_wrong(519				__METHOD__,520				sprintf(521					// translators: %s: A tag name like IFRAME or TEXTAREA.522					__( 'The context element "%s" is not supported.' ),523					$tag_name524				),525				'6.8.0'526			);527			return null;528		}529 530		$fragment_processor = new static( $html, self::CONSTRUCTOR_UNLOCK_CODE );531 532		$fragment_processor->compat_mode = $this->compat_mode;533 534		// @todo Create "fake" bookmarks for non-existent but implied nodes.535		$fragment_processor->bookmarks['root-node'] = new WP_HTML_Span( 0, 0 );536		$root_node                                  = new WP_HTML_Token(537			'root-node',538			'HTML',539			false540		);541		$fragment_processor->state->stack_of_open_elements->push( $root_node );542 543		$fragment_processor->bookmarks['context-node']   = new WP_HTML_Span( 0, 0 );544		$fragment_processor->context_node                = clone $this->current_element->token;545		$fragment_processor->context_node->bookmark_name = 'context-node';546		$fragment_processor->context_node->on_destroy    = null;547 548		$fragment_processor->breadcrumbs = array( 'HTML', $fragment_processor->context_node->node_name );549 550		if ( 'TEMPLATE' === $fragment_processor->context_node->node_name ) {551			$fragment_processor->state->stack_of_template_insertion_modes[] = WP_HTML_Processor_State::INSERTION_MODE_IN_TEMPLATE;552		}553 554		$fragment_processor->reset_insertion_mode_appropriately();555 556		/*557		 * > Set the parser's form element pointer to the nearest node to the context element that558		 * > is a form element (going straight up the ancestor chain, and including the element559		 * > itself, if it is a form element), if any. (If there is no such form element, the560		 * > form element pointer keeps its initial value, null.)561		 */562		foreach ( $this->state->stack_of_open_elements->walk_up() as $element ) {563			if ( 'FORM' === $element->node_name && 'html' === $element->namespace ) {

Changelog

Introduced in 6.8.0. Unchanged from 6.8.8 through 7.1.0.

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

Signature, return type and hooks compared across 4 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.