WP_Interactivity_API::evaluate( array $entry ): mixed|null

Compatibility

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

Parameters

$entryarray

An array containing a whole directive entry with its namespace, value, suffix, or unique ID.

Return value

mixed|null

The result of the evaluation. Null if the reference path doesn't exist or the namespace is falsy.

Performance profile

How much work a call to WP_Interactivity_API::evaluate() 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 what you pass in.

Instructions

30–67

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

5

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

What it touches

• serializeserialisationjson_encode()called directly
• hookthird-party callbacksdo_action()one call below WP_Interactivity_API::evaluate()

Further down the call graph this can also reach query, option, cache 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 WP_Interactivity_API::evaluate() can have, taken from its control-flow graph on PHP 8.5.

Uses · 3

• __()Retrieves the translation of $text.
• _doing_it_wrong()Marks something as being incorrectly called.
• array_is_list()Polyfill for `array_is_list()` function added in PHP 8.1.

Used by · 5

• WP_Interactivity_API::data_wp_bind_processor()Processes the `data-wp-bind` directive.
• WP_Interactivity_API::data_wp_class_processor()Processes the `data-wp-class` directive.
• WP_Interactivity_API::data_wp_each_processor()Processes the `data-wp-each` directive.
• WP_Interactivity_API::data_wp_style_processor()Processes the `data-wp-style` directive.
• WP_Interactivity_API::data_wp_text_processor()Processes the `data-wp-text` directive.

Source code

View on Trac ↗View on GitHub ↗

663	private function evaluate( $entry ) {664		$context                               = end( $this->context_stack );665		['namespace' => $ns, 'value' => $path] = $entry;666 667		if ( ! $ns || ! $path ) {668			/* translators: %s: The directive value referenced. */669			$message = sprintf( __( 'Namespace or reference path cannot be empty. Directive value referenced: %s' ), json_encode( $entry ) );670			_doing_it_wrong( __METHOD__, $message, '6.6.0' );671			return null;672		}673 674		$store = array(675			'state'   => $this->state_data[ $ns ] ?? array(),676			'context' => $context[ $ns ] ?? array(),677		);678 679		// Checks if the reference path is preceded by a negation operator (!).680		$should_negate_value = '!' === $path[0];681		$path                = $should_negate_value ? substr( $path, 1 ) : $path;682 683		// Extracts the value from the store using the reference path.684		$path_segments = explode( '.', $path );685		$current       = $store;686		foreach ( $path_segments as $index => $path_segment ) {687			/*688			 * Special case for numeric arrays and strings. Add length689			 * property mimicking JavaScript behavior.690			 *691			 * @since 6.8.0692			 */693			if ( 'length' === $path_segment ) {694				if ( is_array( $current ) && array_is_list( $current ) ) {695					$current = count( $current );696					break;697				}698 699				if ( is_string( $current ) ) {700					/*701					 * Differences in encoding between PHP strings and702					 * JavaScript mean that it's complicated to calculate703					 * the string length JavaScript would see from PHP.704					 * `strlen` is a reasonable approximation.705					 *706					 * Users that desire a more precise length likely have707					 * more precise needs than "bytelength" and should708					 * implement their own length calculation in derived709					 * state taking into account encoding and their desired710					 * output (codepoints, graphemes, bytes, etc.).711					 */712					$current = strlen( $current );713					break;714				}715			}716 717			if ( ( is_array( $current ) || $current instanceof ArrayAccess ) && isset( $current[ $path_segment ] ) ) {718				$current = $current[ $path_segment ];719			} elseif ( is_object( $current ) && isset( $current->$path_segment ) ) {720				$current = $current->$path_segment;721			} else {722				$current = null;723				break;724			}725 726			if ( $current instanceof Closure ) {727				/*728				 * This state getter's namespace is added to the stack so that729				 * `state()` or `get_config()` read that namespace when called730				 * without specifying one.731				 */732				array_push( $this->namespace_stack, $ns );733				try {734					$current = $current();735 736					/*737					 * Tracks derived state properties that are accessed during738					 * rendering.739					 *740					 * @since 6.9.0741					 */742					$this->derived_state_closures[ $ns ] = $this->derived_state_closures[ $ns ] ?? array();

Changelog

Introduced in 6.5.0. 2 changes between 6.7.7 and 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/interactivity-api/class-wp-interactivity-api.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.