WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_HTML_Processor::bookmark_token()

WP_HTML_Processor::bookmark_token(): string|false

In this article

Back to top

This function’s access is marked private. This means it is not intended for use by plugin or theme developers, only by core. It is listed here for completeness.

Creates a new bookmark for the currently-matched token and returns the generated name.

Return

string|false Name of created bookmark, or false if unable to create.

Source

private function bookmark_token() {
	if ( ! parent::set_bookmark( ++$this->bookmark_counter ) ) {
		$this->last_error = self::ERROR_EXCEEDED_MAX_BOOKMARKS;
		throw new Exception( 'could not allocate bookmark' );
	}

	return "{$this->bookmark_counter}";
}

View all references View on Trac View on GitHub

UsesDescription
WP_HTML_Tag_Processor::set_bookmark()wp-includes/html-api/class-wp-html-tag-processor.php

Sets a bookmark in the HTML document.

Used byDescription
WP_HTML_Processor::insert_virtual_node()wp-includes/html-api/class-wp-html-processor.php

Inserts a virtual element on the stack of open elements.

WP_HTML_Processor::step()wp-includes/html-api/class-wp-html-processor.php

Steps through the HTML document and stop at the next tag, if any.

Changelog

VersionDescription
6.5.0Renamed from bookmark_tag() to bookmark_token().
6.4.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.