WP_HTML_Processor::get_token_type(): string|null

Indicates the kind of matched token, if any.

Description

This differs from get_token_name() in that it always returns a static string indicating the type, whereas get_token_name() may return values derived from the token itself, such as a tag name or processing instruction tag.

Possible values:

#tag when matched on a tag.
#text when matched on a text node.
#cdata-section when matched on a CDATA node.
#comment when matched on a comment.
#doctype when matched on a DOCTYPE declaration.
#presumptuous-tag when matched on an empty tag closer.
#funky-comment when matched on a funky comment.
#processing-instruction when matched on a processing instruction.

Return

string|null What kind of token is matched, or null.

Source

public function get_token_type(): ?string {
	if ( $this->is_virtual() ) {
		/*
		 * This logic comes from the Tag Processor.
		 *
		 * @todo It would be ideal not to repeat this here, but it's not clearly
		 *       better to allow passing a token name to `get_token_type()`.
		 */
		$node_name     = $this->current_element->token->node_name;
		$starting_char = $node_name[0];
		if ( 'A' <= $starting_char && 'Z' >= $starting_char ) {
			return '#tag';
		}

		if ( 'html' === $node_name ) {
			return '#doctype';
		}

		return $node_name;
	}

	return parent::get_token_type();
}

View all references View on Trac View on GitHub

Uses	Description
WP_HTML_Tag_Processor::get_token_type()`wp-includes/html-api/class-wp-html-tag-processor.php`	Indicates the kind of matched token, if any.

Used by	Description
WP_HTML_Processor::serialize_token()`wp-includes/html-api/class-wp-html-processor.php`	Serializes the currently-matched token.
WP_HTML_Processor::create_fragment_at_current_node()`wp-includes/html-api/class-wp-html-processor.php`	Creates a fragment processor at the current node.
WP_HTML_Processor::is_tag_closer()`wp-includes/html-api/class-wp-html-processor.php`	Indicates if the current tag token is a tag closer.
WP_HTML_Processor::next_tag()`wp-includes/html-api/class-wp-html-processor.php`	Finds the next tag matching the $query.
WP_HTML_Processor::get_tag()`wp-includes/html-api/class-wp-html-processor.php`	Returns the uppercase name of the matched tag.

Changelog

Version	Description
7.1.0	Recognize processing instructions according to an HTML specification update.
6.6.0	Introduced.

User Contributed Notes

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