WP_Interactivity_API::data_wp_each_processor( WP_Interactivity_API_Directives_Processor $p, string $mode, array $tag_stack )

Description

Compatibility

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

Parameters

$pWP_Interactivity_API_Directives_Processor

The directives processor instance.

$modestring

Whether the processing is entering or exiting the tag.

$tag_stackarray

The reference to the tag stack.

Performance profile

How much work a call to WP_Interactivity_API::data_wp_each_processor() 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

6–111

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

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 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_Interactivity_API::data_wp_each_processor() can have, taken from its control-flow graph on PHP 8.5.

Uses · 8

• array_is_list()Polyfill for `array_is_list()` function added in PHP 8.1.
• str_starts_with()Polyfill for `str_starts_with()` function added in PHP 8.0.
• str_ends_with()Polyfill for `str_ends_with()` function added in PHP 8.0.
• WP_Interactivity_API::get_directive_entries()Parse the HTML element and get all the valid directives with the given prefix.
• WP_Interactivity_API::kebab_to_camel_case()Transforms a kebab-case string to camelCase.
• WP_Interactivity_API::evaluate()Evaluates the reference path passed to a directive based on the current store namespace, state and context.
• WP_Interactivity_API::_process_directives()Processes the interactivity directives contained within the HTML content and updates the markup accordingly.
• WP_Interactivity_API_Directives_Processor::__construct()

Source code

View on Trac ↗View on GitHub ↗

1537	private function data_wp_each_processor( WP_Interactivity_API_Directives_Processor $p, string $mode, array &$tag_stack ) {1538		if ( 'enter' === $mode && 'TEMPLATE' === $p->get_tag() ) {1539			$entries = $this->get_directive_entries( $p, 'each' );1540			if ( count( $entries ) > 1 || empty( $entries ) ) {1541				// There should be only one `data-wp-each` directive per template tag.1542				return;1543			}1544			$entry = $entries[0];1545			if ( null !== $entry['unique_id'] ) {1546				return;1547			}1548			$item_name = isset( $entry['suffix'] ) ? $this->kebab_to_camel_case( $entry['suffix'] ) : 'item';1549			$result    = $this->evaluate( $entry );1550 1551			// Gets the content between the template tags and leaves the cursor in the closer tag.1552			$inner_content = $p->get_content_between_balanced_template_tags();1553 1554			// Checks if there is a manual server-side directive processing.1555			$template_end = 'data-wp-each: template end';1556			$p->set_bookmark( $template_end );1557			$p->next_tag();1558			$manual_sdp = $p->get_attribute( 'data-wp-each-child' );1559			$p->seek( $template_end ); // Rewinds to the template closer tag.1560			$p->release_bookmark( $template_end );1561 1562			/*1563			 * It doesn't process in these situations:1564			 * - Manual server-side directive processing.1565			 * - Empty or non-array values.1566			 * - Associative arrays because those are deserialized as objects in JS.1567			 * - Templates that contain top-level texts because those texts can't be1568			 *   identified and removed in the client.1569			 */1570			if (1571				$manual_sdp ||1572				empty( $result ) ||1573				! is_array( $result ) ||1574				! array_is_list( $result ) ||1575				! str_starts_with( trim( $inner_content ), '<' ) ||1576				! str_ends_with( trim( $inner_content ), '>' )1577			) {1578				array_pop( $tag_stack );1579				return;1580			}1581 1582			// Processes the inner content for each item of the array.1583			$processed_content = '';1584			foreach ( $result as $item ) {1585				// Creates a new context that includes the current item of the array.1586				$this->context_stack[] = array_replace_recursive(1587					end( $this->context_stack ) !== false ? end( $this->context_stack ) : array(),1588					array( $entry['namespace'] => array( $item_name => $item ) )1589				);1590 1591				// Processes the inner content with the new context.1592				$processed_item = $this->_process_directives( $inner_content );1593 1594				if ( null === $processed_item ) {1595					// If the HTML is unbalanced, stop processing it.1596					array_pop( $this->context_stack );1597					return;1598				}1599 1600				/*1601				 * Adds the `data-wp-each-child` directive to each top-level tag1602				 * rendered by this `data-wp-each` directive. The value is the1603				 * `data-wp-each` directive's namespace and path.1604				 *1605				 * Nested `data-wp-each` directives could render1606				 * `data-wp-each-child` elements at the top level as well, and1607				 * they should be overwritten.1608				 *1609				 * @since 6.9.01610				 */1611				$i = new WP_Interactivity_API_Directives_Processor( $processed_item );1612				while ( $i->next_tag() ) {1613					$i->set_attribute( 'data-wp-each-child', $entry['namespace'] . '::' . $entry['value'] );1614					$i->next_balanced_tag_closer_tag();1615				}1616				$processed_content .= $i->get_updated_html();

Changelog

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