wppaste
WordPress

block_core_navigation_add_directives_to_submenu( WP_HTML_Tag_Processor $tags, array $block_attributes ): string

Since
6.3.0
Source
wp-includes/blocks/navigation.php:1217
Add Interactivity API directives to the navigation-submenu and page-list blocks markup using the Tag Processor.

Compatibility

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

$tagsWP_HTML_Tag_Processor
Markup of the navigation block.
$block_attributesarray
Block attributes.

Return value

string
Submenu markup with the directives injected.

Performance profile

How much work a call to block_core_navigation_add_directives_to_submenu() 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
10

Executed per call on PHP 8.5. The body compiles to 72.

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 one call costs · 1 distinct outcome

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

WhenInstructionsCalls it makes
!->next_tag()10->next_tag(), ->get_updated_html()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 72 instructions, 10 executed per call, 4 branches. The work does not change between versions.

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 · 2

Used by · 2

Source code

function block_core_navigation_add_directives_to_submenu( $tags, $block_attributes ) {	while ( $tags->next_tag(		array(			'tag_name'   => 'LI',			'class_name' => 'has-child',		)	) ) {		// Add directives to the parent `<li>`.		$tags->set_attribute( 'data-wp-interactive', 'core/navigation' );		$tags->set_attribute( 'data-wp-context', '{ "submenuOpenedBy": { "click": false, "hover": false, "focus": false }, "type": "submenu", "modal": null, "previousFocus": null }' );		$tags->set_attribute( 'data-wp-watch', 'callbacks.initMenu' );		$tags->set_attribute( 'data-wp-on--focusout', 'actions.handleMenuFocusout' );		$tags->set_attribute( 'data-wp-on--keydown', 'actions.handleMenuKeydown' ); 		// This is a fix for Safari. Without it, Safari doesn't change the active		// element when the user clicks on a button. It can be removed once we add		// an overlay to capture the clicks, instead of relying on the focusout		// event.		$tags->set_attribute( 'tabindex', '-1' ); 		$computed_visibility = block_core_navigation_get_submenu_visibility( $block_attributes );		$open_on_hover       = 'hover' === $computed_visibility; 		if ( $open_on_hover ) {			$tags->set_attribute( 'data-wp-on--pointerenter', 'actions.openMenuOnHover' );			$tags->set_attribute( 'data-wp-on--pointerleave', 'actions.closeMenuOnHover' );		} 		// Add directives to the toggle submenu button.		if ( $tags->next_tag(			array(				'tag_name'   => 'BUTTON',				'class_name' => 'wp-block-navigation-submenu__toggle',			)		) ) {			$tags->set_attribute( 'data-wp-on--click', 'actions.toggleMenuOnClick' );			$tags->set_attribute( 'data-wp-bind--aria-expanded', 'state.isSubmenuOpen' );			// The `aria-expanded` attribute for SSR is already added in the submenu block.		}		// Add directives to the submenu.		if ( $tags->next_tag(			array(				'tag_name'   => 'UL',				'class_name' => 'wp-block-navigation__submenu-container',			)		) ) {			$tags->set_attribute( 'data-wp-on--focus', 'actions.openMenuOnFocus' );		} 		// Iterate through subitems if exist.		block_core_navigation_add_directives_to_submenu( $tags, $block_attributes );	}	return $tags->get_updated_html();}

Changelog

Introduced in 6.3.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/blocks/navigation.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.