wppaste
WordPress

WP_HTML_Processor::escape_text_for_serialization( string $text ): string

Since
7.1.0
Source
wp-includes/html-api/class-wp-html-processor.php:1545
Escapes decoded text for HTML serialization.

Description

Use for:

  • Attribute values.
  • Text in ordinary (data-state) elements and in the RCDATA elements (TITLE and TEXTAREA).
  • Text in foreign content (elements not in the HTML namespace).

Do not use for text in the RAWTEXT elements (STYLE, XMP, IFRAME, NOEMBED, NOFRAMES), HTML SCRIPT elements, or PLAINTEXT elements, whose contents serialize without escaping.

Compatibility

WordPress
since 7.1.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in 1 of the 5 tracked releases, added in 7.1.0, and compiles on PHP 7.4 through 8.6-dev.

Parameters

$textstring
Decoded text to escape.

Return value

string
Escaped text.

Performance profile

How much work a call to WP_HTML_Processor::escape_text_for_serialization() 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
14

Executed per call on PHP 8.5. The body compiles to 14.

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 · 1 distinct outcome

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

WhenInstructionsCalls it makes
always14htmlspecialchars()

Across PHP versions

PHPCompiledExecutedBranchesNotes
8.6-dev14140
8.5141401 more instruction than PHP 8.4
8.4131306 fewer instructions than PHP 8.3
8.319190
8.219190
8.119190
7.419190

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Used by · 1

Source code

View on Trac View on GitHub 

	private static function escape_text_for_serialization( string $text ): string {		$text = htmlspecialchars( $text, ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML5, 'UTF-8' ); 		$text = str_replace( "\r", '
', $text ); 		return str_replace( "\x00", "\u{FFFD}", $text );	}

Changelog

Introduced in 7.1.0.

Signature, return type and hooks compared across 1 parsed release.

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.