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.10 to 7.1.3), 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–126

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

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 · 20 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 · 9

• 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::extract_prefix_and_suffix()Extracts the directive attribute name to separate and return the directive prefix and an optional suffix.
• 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::extract_directive_value()Parses and extracts the namespace and reference path from the given directive attribute value.
• 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 ↗

1130	private function data_wp_each_processor( WP_Interactivity_API_Directives_Processor $p, string $mode, array &$tag_stack ) {1131		if ( 'enter' === $mode && 'TEMPLATE' === $p->get_tag() ) {1132			$attribute_name   = $p->get_attribute_names_with_prefix( 'data-wp-each' )[0];1133			$extracted_suffix = $this->extract_prefix_and_suffix( $attribute_name );1134			$item_name        = isset( $extracted_suffix[1] ) ? $this->kebab_to_camel_case( $extracted_suffix[1] ) : 'item';1135			$attribute_value  = $p->get_attribute( $attribute_name );1136			$result           = $this->evaluate( $attribute_value );1137 1138			// Gets the content between the template tags and leaves the cursor in the closer tag.1139			$inner_content = $p->get_content_between_balanced_template_tags();1140 1141			// Checks if there is a manual server-side directive processing.1142			$template_end = 'data-wp-each: template end';1143			$p->set_bookmark( $template_end );1144			$p->next_tag();1145			$manual_sdp = $p->get_attribute( 'data-wp-each-child' );1146			$p->seek( $template_end ); // Rewinds to the template closer tag.1147			$p->release_bookmark( $template_end );1148 1149			/*1150			 * It doesn't process in these situations:1151			 * - Manual server-side directive processing.1152			 * - Empty or non-array values.1153			 * - Associative arrays because those are deserialized as objects in JS.1154			 * - Templates that contain top-level texts because those texts can't be1155			 *   identified and removed in the client.1156			 */1157			if (1158				$manual_sdp ||1159				empty( $result ) ||1160				! is_array( $result ) ||1161				! array_is_list( $result ) ||1162				! str_starts_with( trim( $inner_content ), '<' ) ||1163				! str_ends_with( trim( $inner_content ), '>' )1164			) {1165				array_pop( $tag_stack );1166				return;1167			}1168 1169			// Extracts the namespace from the directive attribute value.1170			$namespace_value         = end( $this->namespace_stack );1171			list( $namespace_value ) = is_string( $attribute_value ) && ! empty( $attribute_value )1172				? $this->extract_directive_value( $attribute_value, $namespace_value )1173				: array( $namespace_value, null );1174 1175			// Processes the inner content for each item of the array.1176			$processed_content = '';1177			foreach ( $result as $item ) {1178				// Creates a new context that includes the current item of the array.1179				$this->context_stack[] = array_replace_recursive(1180					end( $this->context_stack ) !== false ? end( $this->context_stack ) : array(),1181					array( $namespace_value => array( $item_name => $item ) )1182				);1183 1184				// Processes the inner content with the new context.1185				$processed_item = $this->_process_directives( $inner_content );1186 1187				if ( null === $processed_item ) {1188					// If the HTML is unbalanced, stop processing it.1189					array_pop( $this->context_stack );1190					return;1191				}1192 1193				// Adds the `data-wp-each-child` to each top-level tag.1194				$i = new WP_Interactivity_API_Directives_Processor( $processed_item );1195				while ( $i->next_tag() ) {1196					$i->set_attribute( 'data-wp-each-child', true );1197					$i->next_balanced_tag_closer_tag();1198				}1199				$processed_content .= $i->get_updated_html();1200 1201				// Removes the current context from the stack.1202				array_pop( $this->context_stack );1203			}1204 1205			// Appends the processed content after the tag closer of the template.1206			$p->append_content_after_template_tag_closer( $processed_content );1207 1208			// Pops the last tag because it skipped the closing tag of the template tag.1209			array_pop( $tag_stack );

Changelog

Introduced in 6.5.0. Unchanged from 6.7.10 through 7.1.3.

1. 6.7.10
2. 6.8.11
3. 6.9.10
4. 7.0.7
5. 7.1.3

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.10 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.