WP_HTML_Tag_Processor::get_full_comment_text(): string|null

Returns the text of a matched comment or null if not on a comment type node.

Description

This method returns the entire text content of a comment node as it would appear in the browser.

This differs from ::get_modifiable_text() in that certain comment types in the HTML API cannot allow their entire comment text content to be modified. Namely, “bogus comments” of the form <?not allowed in html> will create a comment whose text content starts with ?. Note that if that character were modified, it would be possible to change the node type.

Return

string|null The comment text as it would appear in the browser or null if not on a comment type node.

Source

public function get_full_comment_text(): ?string {
	if ( self::STATE_FUNKY_COMMENT === $this->parser_state ) {
		return $this->get_modifiable_text();
	}

	if ( self::STATE_COMMENT !== $this->parser_state ) {
		return null;
	}

	switch ( $this->get_comment_type() ) {
		case self::COMMENT_AS_HTML_COMMENT:
		case self::COMMENT_AS_ABRUPTLY_CLOSED_COMMENT:
			return $this->get_modifiable_text();

		case self::COMMENT_AS_CDATA_LOOKALIKE:
			return "[CDATA[{$this->get_modifiable_text()}]]";

		case self::COMMENT_AS_PI_NODE_LOOKALIKE:
			return "?{$this->get_tag()}{$this->get_modifiable_text()}?";

		/*
		 * This represents "bogus comments state" from HTML tokenization.
		 * This can be entered by `<?` or `<!`, where `?` is included in
		 * the comment text but `!` is not.
		 */
		case self::COMMENT_AS_INVALID_HTML:
			$preceding_character = $this->html[ $this->text_starts_at - 1 ];
			$comment_start       = '?' === $preceding_character ? '?' : '';
			return "{$comment_start}{$this->get_modifiable_text()}";
	}

	return null;
}

View all references View on Trac View on GitHub

Uses	Description
WP_HTML_Tag_Processor::get_modifiable_text()`wp-includes/html-api/class-wp-html-tag-processor.php`	Returns the modifiable text for a matched token, or an empty string.
WP_HTML_Tag_Processor::get_comment_type()`wp-includes/html-api/class-wp-html-tag-processor.php`	Indicates what kind of comment produced the comment node.
WP_HTML_Tag_Processor::get_tag()`wp-includes/html-api/class-wp-html-tag-processor.php`	Returns the uppercase name of the matched tag.

Changelog

Version	Description
6.7.0	Introduced.

User Contributed Notes

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