wppaste
WordPress

prep_atom_text_construct( string $data ): array

Since
2.5.0
Source
wp-includes/feed.php:588
Determines the type of a string of data with the data formatted.

Description

Tell whether the type is text, HTML, or XHTML, per RFC 4287 section 3.1.

In the case of WordPress, text is defined as containing no markup, XHTML is defined as "well formed", and HTML as tag soup (i.e., the rest).

Container div tags are added to XHTML values, per section 3.1.1.3.

Compatibility

WordPress
since 2.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

$datastring
Input string.

Return value

array
array(type, value)

Performance profile

How much work a call to prep_atom_text_construct() 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
8–29

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

  • hookthird-party callbacksdo_action()one call below prep_atom_text_construct()

Further down the call graph this can also reach query, option, cache, serialize 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 · 3 distinct outcomes

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

WhenInstructionsCalls it makes
!$data8none
$data23–29xml_parser_create(), xml_parse(), xml_get_error_code()
$data && xml_get_error_code()26–28xml_parser_create(), xml_parse(), xml_get_error_code(), htmlspecialchars()

Across PHP versions

PHPCompiledExecutedBranchesNotes
8.6-dev498–295
8.5498–295
8.4498–29512 fewer instructions than PHP 8.3
8.36114–385
8.26114–385
8.16114–3853 fewer instructions than PHP 7.4
7.46414–415

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.

Uses · 3

  • str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
  • wp_trigger_error()Generates a user-level error/warning/notice/deprecation message.
  • __()Retrieves the translation of $text.

Source code

View on Trac View on GitHub 

function prep_atom_text_construct( $data ) {	if ( ! str_contains( $data, '<' ) && ! str_contains( $data, '&' ) ) {		return array( 'text', $data );	} 	if ( ! function_exists( 'xml_parser_create' ) ) {		wp_trigger_error( '', __( "PHP's XML extension is not available. Please contact your hosting provider to enable PHP's XML extension." ) ); 		return array( 'html', "<![CDATA[$data]]>" );	} 	$parser = xml_parser_create();	xml_parse( $parser, '<div>' . $data . '</div>', true );	$code = xml_get_error_code( $parser ); 	if ( PHP_VERSION_ID < 80000 ) { // xml_parser_free() has no effect as of PHP 8.0.		xml_parser_free( $parser );	} 	unset( $parser ); 	if ( ! $code ) {		if ( ! str_contains( $data, '<' ) ) {			return array( 'text', $data );		} else {			$data = "<div xmlns='http://www.w3.org/1999/xhtml'>$data</div>";			return array( 'xhtml', $data );		}	} 	if ( ! str_contains( $data, ']]>' ) ) {		return array( 'html', "<![CDATA[$data]]>" );	} else {		return array( 'html', htmlspecialchars( $data ) );	}}

Changelog

Introduced in 2.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/feed.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.