WP_Navigation_Block_Renderer::get_responsive_container_markup( array $attributes, WP_Block_List $inner_blocks, string $inner_blocks_html ): string

Compatibility

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

Parameters

$attributesarray

The block attributes.

$inner_blocksWP_Block_List

The list of inner blocks.

$inner_blocks_htmlstring

The markup for the inner blocks.

Return value

string

Returns the container markup.

Performance profile

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

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

104–159

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

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 it touches

• hookthird-party callbacksapply_filters()one call below WP_Navigation_Block_Renderer::get_responsive_container_markup()

Further down the call graph this can also reach option, cache, serialize, query 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 · 20 distinct outcomes

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

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Uses · 13

• block_core_navigation_build_css_colors()Build an array with CSS classes and inline styles defining the colors which will be applied to the navigation markup in the front-end.
• wp_unique_id()Gets unique ID.
• block_core_navigation_overlay_html_has_close_block()Checks if the overlay HTML contains a navigation-overlay-close block.
• block_core_navigation_add_directives_to_overlay_close()Add Interactivity API directives to the navigation-overlay-close block markup using the Tag Processor.
• block_core_navigation_set_overlay_image_fetch_priority()Sets fetchpriority="low" on all IMG tags within the navigation overlay.
• __()Retrieves the translation of $text.
• esc_attr()Escaping for HTML attributes.
• static::is_interactive()
• static::get_overlay_blocks_from_template_part()
• static::get_template_part_blocks_html()
• WP_HTML_Tag_Processor::__construct()Constructor.
• static::get_responsive_container_classes()

Source code

View on Trac ↗View on GitHub ↗

730<?php731	private static function get_responsive_container_markup( $attributes, $inner_blocks, $inner_blocks_html ) {732		$is_interactive  = static::is_interactive( $attributes, $inner_blocks );733		$colors          = block_core_navigation_build_css_colors( $attributes );734		$modal_unique_id = wp_unique_id( 'modal-' );735 736		$is_hidden_by_default = isset( $attributes['overlayMenu'] ) && 'always' === $attributes['overlayMenu'];737 738		// Set-up variables for custom overlays.739		$has_custom_overlay             = false;740		$close_button_markup            = '';741		$has_custom_overlay_close_block = false;742		$overlay_blocks_html            = '';743		$custom_overlay_markup          = '';744 745		// Check if an overlay template part is selected and render it.746		// This needs to happen before building classes so we know if overlay blocks actually exist.747		if ( ! empty( $attributes['overlay'] ) ) {748			// Get blocks from the overlay template part.749			$overlay_blocks = static::get_overlay_blocks_from_template_part( $attributes['overlay'], $attributes );750			// Render template part blocks directly without navigation container wrapper.751			$overlay_blocks_html = static::get_template_part_blocks_html( $overlay_blocks );752			// Check if overlay contains a navigation-overlay-close block (detect in rendered HTML so it works with patterns).753			$has_custom_overlay_close_block = block_core_navigation_overlay_html_has_close_block( $overlay_blocks_html );754			// Add Interactivity API directives to the overlay close block if present.755			if ( $has_custom_overlay_close_block && $is_interactive ) {756				$tags                = new WP_HTML_Tag_Processor( $overlay_blocks_html );757				$overlay_blocks_html = block_core_navigation_add_directives_to_overlay_close( $tags );758			}759			// Images in the overlay are hidden until the menu is opened. Pre-set760			// fetchpriority="low" so that when wp_filter_content_tags() processes the761			// parent template part, it sees the attribute already present and calls762			// wp_get_loading_optimization_attributes() with fetchpriority="low", which both prevents763			// fetchpriority="high" from being added and stops the LCP counter from being incremented.764			$overlay_blocks_html = block_core_navigation_set_overlay_image_fetch_priority( $overlay_blocks_html );765		}766 767		$has_custom_overlay = ! empty( $overlay_blocks_html );768 769		$responsive_container_classes = static::get_responsive_container_classes( $is_hidden_by_default, $has_custom_overlay, $colors );770 771		$open_button_classes = array(772			'wp-block-navigation__responsive-container-open',773			$is_hidden_by_default ? 'always-shown' : '',774		);775 776		$should_display_icon_label = isset( $attributes['hasIcon'] ) && true === $attributes['hasIcon'];777		$toggle_button_icon        = '<svg width="24" height="24" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" aria-hidden="true" focusable="false"><path d="M4 7.5h16v1.5H4z"></path><path d="M4 15h16v1.5H4z"></path></svg>';778		if ( isset( $attributes['icon'] ) ) {779			if ( 'menu' === $attributes['icon'] ) {780				$toggle_button_icon = '<svg width="24" height="24" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M5 5v1.5h14V5H5z"></path><path d="M5 12.8h14v-1.5H5v1.5z"></path><path d="M5 19h14v-1.5H5V19z"></path></svg>';781			}782		}783		$toggle_button_content       = $should_display_icon_label ? $toggle_button_icon : __( 'Menu' );784		$toggle_close_button_icon    = '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" focusable="false"><path d="m13.06 12 6.47-6.47-1.06-1.06L12 10.94 5.53 4.47 4.47 5.53 10.94 12l-6.47 6.47 1.06 1.06L12 13.06l6.47 6.47 1.06-1.06L13.06 12Z"></path></svg>';785		$toggle_close_button_content = $should_display_icon_label ? $toggle_close_button_icon : __( 'Close' );786		$toggle_aria_label_open      = $should_display_icon_label ? 'aria-label="' . __( 'Open menu' ) . '"' : ''; // Open button label.787		$toggle_aria_label_close     = $should_display_icon_label ? 'aria-label="' . __( 'Close menu' ) . '"' : ''; // Close button label.788 789		// Add Interactivity API directives to the markup if needed.790		$open_button_directives          = '';791		$responsive_container_directives = '';792		$responsive_dialog_directives    = '';793		$close_button_directives         = '';794		if ( $is_interactive ) {795			$open_button_directives                  = '796				data-wp-on--click="actions.openMenuOnClick"797				data-wp-on--keydown="actions.handleMenuKeydown"798			';799			$responsive_container_directives         = '800				data-wp-class--has-modal-open="state.isMenuOpen"801				data-wp-class--is-menu-open="state.isMenuOpen"802				data-wp-watch="callbacks.initMenu"803				data-wp-on--keydown="actions.handleMenuKeydown"804				data-wp-on--focusout="actions.handleMenuFocusout"805				tabindex="-1"806			';807			$responsive_dialog_directives            = '808				data-wp-bind--aria-modal="state.ariaModal"809				data-wp-bind--aria-label="state.ariaLabel"810				data-wp-bind--role="state.roleAttribute"

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/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.