WP_HTML_Processor::serialize_token(): string

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Return value

string

Serialization of token, or empty string if no serialization exists.

Performance profile

How much work a call to WP_HTML_Processor::serialize_token() 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 how much data it finds.

Instructions

13–111

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

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 one call costs · 15 distinct outcomes

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

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Uses · 15

• str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
• wp_scrub_utf8()Replaces ill-formed UTF-8 byte sequences with the Unicode Replacement Character.
• WP_HTML_Processor::get_token_type()Indicates the kind of matched token, if any.
• WP_HTML_Processor::get_doctype_info()
• WP_HTML_Processor::escape_text_for_serialization()Escapes decoded text for HTML serialization.
• WP_HTML_Processor::get_modifiable_text()Returns the modifiable text for a matched token, or an empty string.
• WP_HTML_Processor::get_full_comment_text()
• WP_HTML_Processor::get_tag()Returns the uppercase name of the matched tag.
• WP_HTML_Processor::get_namespace()Indicates the namespace of the current token, or "html" if there is none.
• WP_HTML_Processor::get_qualified_tag_name()
• WP_HTML_Processor::is_tag_closer()Indicates if the current tag token is a tag closer.
• WP_HTML_Processor::get_attribute_names_with_prefix()Gets lowercase names of all attributes matching a given prefix in the current tag.

Used by · 1

• WP_HTML_Processor::serialize()Returns normalized HTML for a fragment by serializing it.

Source code

View on Trac ↗View on GitHub ↗

1357	public function serialize_token(): string {1358		$html       = '';1359		$token_type = $this->get_token_type();1360 1361		switch ( $token_type ) {1362			case '#doctype':1363				$doctype = $this->get_doctype_info();1364				if ( null === $doctype ) {1365					break;1366				}1367 1368				$html .= '<!DOCTYPE';1369 1370				if ( $doctype->name ) {1371					$html .= " {$doctype->name}";1372				}1373 1374				if ( null !== $doctype->public_identifier ) {1375					$quote = str_contains( $doctype->public_identifier, '"' ) ? "'" : '"';1376					$html .= " PUBLIC {$quote}{$doctype->public_identifier}{$quote}";1377				}1378				if ( null !== $doctype->system_identifier ) {1379					if ( null === $doctype->public_identifier ) {1380						$html .= ' SYSTEM';1381					}1382					$quote = str_contains( $doctype->system_identifier, '"' ) ? "'" : '"';1383					$html .= " {$quote}{$doctype->system_identifier}{$quote}";1384				}1385 1386				$html .= '>';1387				break;1388 1389			case '#text':1390				$html .= self::escape_text_for_serialization( $this->get_modifiable_text() );1391				break;1392 1393			// Unlike the `<>` which is interpreted as plaintext, this is ignored entirely.1394			case '#presumptuous-tag':1395				break;1396 1397			case '#funky-comment':1398			case '#comment':1399				$html .= "<!--{$this->get_full_comment_text()}-->";1400				break;1401 1402			/**1403			 * Processing instructions are serialized as `"<?" target " " data "?>"`.1404			 *1405			 * @link https://html.spec.whatwg.org/multipage/parsing.html#serialising-html-fragments1406			 */1407			case '#processing-instruction':1408				$html .= "<?{$this->get_tag()} {$this->get_modifiable_text()}?>";1409				break;1410 1411			case '#cdata-section':1412				$html .= "<![CDATA[{$this->get_modifiable_text()}]]>";1413				break;1414		}1415 1416		if ( '#tag' !== $token_type ) {1417			return $html;1418		}1419 1420		$tag_name       = $this->get_tag();1421		$in_html        = 'html' === $this->get_namespace();1422		$qualified_name = $in_html ? strtolower( $tag_name ) : $this->get_qualified_tag_name();1423 1424		if ( $this->is_tag_closer() ) {1425			$html .= "</{$qualified_name}>";1426			return $html;1427		}1428 1429		$attribute_names = $this->get_attribute_names_with_prefix( '' );1430		if ( ! isset( $attribute_names ) ) {1431			$html .= "<{$qualified_name}>";1432			return $html;1433		}1434 1435		$html .= "<{$qualified_name}";1436

Changelog

Introduced in 6.7.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-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.