WP_Interactivity_API::_process_directives( string $html ): string|null

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

$htmlstring

The HTML content to process.

Return value

string|null

The processed HTML content. It returns null when the HTML contains unbalanced tags.

Performance profile

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

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

2

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

What it touches

• hookthird-party callbacksdo_action()one call below WP_Interactivity_API::_process_directives()

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 · 12 distinct outcomes

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

Uses · 4

• __()Retrieves the translation of $text.
• _doing_it_wrong()Marks something as being incorrectly called.
• WP_Interactivity_API_Directives_Processor::__construct()
• WP_Interactivity_API::parse_directive_name()Parse the directive name to extract the following parts: - Prefix: The main directive name without "data-wp-". It cannot begin with a hyphen.

Used by · 2

• WP_Interactivity_API::data_wp_each_processor()Processes the `data-wp-each` directive.
• WP_Interactivity_API::process_directives()Processes the interactivity directives contained within the HTML content and updates the markup accordingly.

Source code

View on Trac ↗View on GitHub ↗

492	private function _process_directives( string $html ) {493		$p          = new WP_Interactivity_API_Directives_Processor( $html );494		$tag_stack  = array();495		$unbalanced = false;496 497		$directive_processor_prefixes          = array_keys( self::$directive_processors );498		$directive_processor_prefixes_reversed = array_reverse( $directive_processor_prefixes );499 500		/*501		 * Save the current size for each stack to restore them in case502		 * the processing finds unbalanced tags.503		 */504		$namespace_stack_size = count( $this->namespace_stack );505		$context_stack_size   = count( $this->context_stack );506 507		while ( $p->next_tag( array( 'tag_closers' => 'visit' ) ) ) {508			$tag_name = $p->get_tag();509 510			/*511			 * Directives inside SVG and MATH tags are not processed,512			 * as they are not compatible with the Tag Processor yet.513			 * We still process the rest of the HTML.514			 */515			if ( 'SVG' === $tag_name || 'MATH' === $tag_name ) {516				if ( $p->get_attribute_names_with_prefix( 'data-wp-' ) ) {517					/* translators: 1: SVG or MATH HTML tag, 2: Namespace of the interactive block. */518					$message = sprintf( __( 'Interactivity directives were detected on an incompatible %1$s tag when processing "%2$s". These directives will be ignored in the server side render.' ), $tag_name, end( $this->namespace_stack ) );519					_doing_it_wrong( __METHOD__, $message, '6.6.0' );520				}521				$p->skip_to_tag_closer();522				continue;523			}524 525			if ( $p->is_tag_closer() ) {526				list( $opening_tag_name, $directives_prefixes ) = ! empty( $tag_stack ) ? end( $tag_stack ) : array( null, null );527 528				if ( 0 === count( $tag_stack ) || $opening_tag_name !== $tag_name ) {529 530					/*531					 * If the tag stack is empty or the matching opening tag is not the532					 * same than the closing tag, it means the HTML is unbalanced and it533					 * stops processing it.534					 */535					$unbalanced = true;536					break;537				} else {538					// Remove the last tag from the stack.539					array_pop( $tag_stack );540				}541			} else {542				$each_child_attrs = $p->get_attribute_names_with_prefix( 'data-wp-each-child' );543				if ( null === $each_child_attrs ) {544					continue;545				}546 547				if ( 0 !== count( $each_child_attrs ) ) {548					/*549					 * If the tag has a `data-wp-each-child` directive, jump to its closer550					 * tag because those tags have already been processed.551					 */552					$p->next_balanced_tag_closer_tag();553					continue;554				} else {555					$directives_prefixes = array();556 557					// Checks if there is a server directive processor registered for each directive.558					foreach ( $p->get_attribute_names_with_prefix( 'data-wp-' ) as $attribute_name ) {559						$parsed_directive = $this->parse_directive_name( $attribute_name );560						if ( empty( $parsed_directive ) ) {561							continue;562						}563						$directive_prefix = 'data-wp-' . $parsed_directive['prefix'];564						if ( array_key_exists( $directive_prefix, self::$directive_processors ) ) {565							$directives_prefixes[] = $directive_prefix;566						}567					}568 569					/*570					 * If this tag will visit its closer tag, it adds it to the tag stack571					 * so it can process its closing tag and check for unbalanced tags.

Changelog

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