wppaste
WordPress

esc_xml( string $text ): string

Since
5.5.0
Source
wp-includes/formatting.php:4760
Escaping for XML blocks.

Compatibility

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

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

Parameters

$textstring
Text to escape.

Return value

string
Escaped text.

Performance profile

How much work a call to esc_xml() 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
Moderate

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
4–14

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

Plugin surface
1 hook

Third-party callbacks on 'esc_xml' run inside this call, and their cost is not bounded by anything here.

Called by
5

5 places in core call this, so the cost is paid more often than your own code shows.

What it touches

  • hookthird-party callbacksapply_filters()called directly
  • optionoption read or writeget_option()one call below esc_xml()

Further down the call graph this can also reach cache, serialize, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 2 distinct outcomes

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

WhenInstructionsCalls it makes
!isset($matches)4none
isset($matches)12–14_wp_specialchars()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 41 instructions, 4–14 executed per call, 2 branches. The work does not change between versions.

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.

Hooks and filters fired · 1

One hook fires while esc_xml() runs, in this order:

  1. apply_filters( esc_xml )filterline 4806 (+46 into the body)

    Filters a string cleaned and escaped for output in XML.

Uses · 3

Used by · 5

Source code

function esc_xml( $text ) {	$safe_text = wp_check_invalid_utf8( $text ); 	$cdata_regex = '\<\!\[CDATA\[.*?\]\]\>';	$regex       = <<<EOF/	(?=.*?{$cdata_regex})                 # lookahead that will match anything followed by a CDATA Section	(?<non_cdata_followed_by_cdata>(.*?)) # the "anything" matched by the lookahead	(?<cdata>({$cdata_regex}))            # the CDATA Section matched by the lookahead |	                                      # alternative 	(?<non_cdata>(.*))                    # non-CDATA Section/sxEOF; 	$safe_text = (string) preg_replace_callback(		$regex,		static function ( $matches ) {			if ( ! isset( $matches[0] ) ) {				return '';			} 			if ( isset( $matches['non_cdata'] ) ) {				// escape HTML entities in the non-CDATA Section.				return _wp_specialchars( $matches['non_cdata'], ENT_XML1 );			} 			// Return the CDATA Section unchanged, escape HTML entities in the rest.			return _wp_specialchars( $matches['non_cdata_followed_by_cdata'], ENT_XML1 ) . $matches['cdata'];		},		$safe_text	); 	/**	 * Filters a string cleaned and escaped for output in XML.	 *	 * Text passed to esc_xml() is stripped of invalid or special characters	 * before output. HTML named character references are converted to their	 * equivalent code points.	 *	 * @since 5.5.0	 *	 * @param string $safe_text The text after it has been escaped.	 * @param string $text      The text prior to being escaped.	 */	return apply_filters( 'esc_xml', $safe_text, $text );}

Changelog

Introduced in 5.5.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 6.9.7 tag, from src/wp-includes/formatting.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.