WP_HTML_Tag_Processor::seek( string $bookmark_name ): 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

$bookmark_namestring

Jump to the place in the document identified by this bookmark name.

Return value

bool

Whether the internal cursor was successfully moved to the bookmark's location.

Performance profile

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

13–32

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

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

What it touches

• hookthird-party callbacksdo_action()one call below WP_HTML_Tag_Processor::seek()

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 · 3 distinct outcomes

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

Uses · 4

• _doing_it_wrong()Marks something as being incorrectly called.
• __()Retrieves the translation of $text.
• WP_HTML_Tag_Processor::get_updated_html()Returns the string representation of the HTML Tag Processor.
• WP_HTML_Tag_Processor::next_token()Finds the next token in the HTML document.

Used by · 1

• WP_HTML_Processor::seek()Moves the internal cursor in the HTML Processor to a given bookmark's location.

Source code

View on Trac ↗View on GitHub ↗

2717	public function seek( $bookmark_name ): bool {2718		if ( ! array_key_exists( $bookmark_name, $this->bookmarks ) ) {2719			_doing_it_wrong(2720				__METHOD__,2721				__( 'Unknown bookmark name.' ),2722				'6.2.0'2723			);2724			return false;2725		}2726 2727		$existing_bookmark = $this->bookmarks[ $bookmark_name ];2728 2729		if (2730			$this->token_starts_at === $existing_bookmark->start &&2731			$this->token_length === $existing_bookmark->length2732		) {2733			return true;2734		}2735 2736		if ( ++$this->seek_count > static::MAX_SEEK_OPS ) {2737			_doing_it_wrong(2738				__METHOD__,2739				__( 'Too many calls to seek() - this can lead to performance issues.' ),2740				'6.2.0'2741			);2742			return false;2743		}2744 2745		// Flush out any pending updates to the document.2746		$this->get_updated_html();2747 2748		// Point this tag processor before the sought tag opener and consume it.2749		$this->bytes_already_parsed = $this->bookmarks[ $bookmark_name ]->start;2750		$this->parser_state         = self::STATE_READY;2751		return $this->next_token();2752	}

Changelog

Introduced in 6.2.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-tag-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.