render_block_core_navigation_submenu( array $attributes, string $content, WP_Block $block ): 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.

$contentstring

The saved content.

$blockWP_Block

The parsed block.

Return value

string

Returns the post content with the legacy widget added.

Performance profile

How much work a call to render_block_core_navigation_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

Heavy

Reaches the database via get_post().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

91–215

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

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

• querycontent queryget_post()one call below render_block_core_navigation_submenu()
• hookthird-party callbacksapply_filters()one call below render_block_core_navigation_submenu()
• optionoption read or writeget_option()one call below render_block_core_navigation_submenu()

Further down the call graph this can also reach 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 · 42 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost render_block_core_navigation_submenu() 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 · 15

• block_core_shared_navigation_item_should_render()Checks if a navigation item should render based on post status.
• get_queried_object_id()Retrieves the ID of the currently queried object.
• get_queried_object()Retrieves the currently queried object.
• is_post_type_archive()Determines whether the query is for an existing post type archive page.
• get_post_type_archive_link()Retrieves the permalink for a post type archive.
• block_core_navigation_submenu_get_submenu_visibility()Returns the submenu visibility value with backward compatibility for the deprecated openSubmenusOnClick attribute.
• get_block_wrapper_attributes()Generates a string of attributes by applying to the current block being rendered all of the features that the block supports.
• wp_kses_post()Sanitizes content for allowed HTML tags for post content.
• __()Retrieves the translation of $text.
• wp_strip_all_tags()Properly strips all HTML tags including 'script' and 'style'.
• esc_url()Checks and cleans a URL.
• esc_attr()Escaping for HTML attributes.

Source code

View on Trac ↗View on GitHub ↗

76function render_block_core_navigation_submenu( $attributes, $content, $block ) {77	// Check if this navigation item should render based on post status.78	if ( defined( 'IS_GUTENBERG_PLUGIN' ) && IS_GUTENBERG_PLUGIN ) {79		$should_render = gutenberg_block_core_shared_navigation_item_should_render( $attributes, $block );80	} else {81		$should_render = block_core_shared_navigation_item_should_render( $attributes, $block );82	}83	if ( ! $should_render ) {84		return '';85	}86 87	// Don't render the block's subtree if it has no label.88	if ( empty( $attributes['label'] ) ) {89		return '';90	}91 92	// Render inner blocks first to check if any menu items will actually display.93	$inner_blocks_html = '';94	foreach ( $block->inner_blocks as $inner_block ) {95		$inner_blocks_html .= $inner_block->render();96	}97	$has_submenu = ! empty( trim( $inner_blocks_html ) );98 99	$kind      = empty( $attributes['kind'] ) ? 'post_type' : str_replace( '-', '_', $attributes['kind'] );100	$is_active = ! empty( $attributes['id'] ) && get_queried_object_id() === (int) $attributes['id'] && ! empty( get_queried_object()->$kind );101 102	if ( is_post_type_archive() && ! empty( $attributes['url'] ) ) {103		$queried_archive_link = get_post_type_archive_link( get_queried_object()->name );104		if ( $attributes['url'] === $queried_archive_link ) {105			$is_active = true;106		}107	}108 109	$show_submenu_indicators = isset( $block->context['showSubmenuIcon'] ) && $block->context['showSubmenuIcon'];110	$computed_visibility     = block_core_navigation_submenu_get_submenu_visibility( $block->context );111	$open_on_click           = 'click' === $computed_visibility;112	$open_on_hover           = 'hover' === $computed_visibility;113	$open_on_hover_and_click = $open_on_hover && $show_submenu_indicators;114 115	$classes = array(116		'wp-block-navigation-item',117	);118 119	if ( $has_submenu ) {120		$classes[] = 'has-child';121	}122	if ( $open_on_click ) {123		$classes[] = 'open-on-click';124	}125	if ( $open_on_hover_and_click ) {126		$classes[] = 'open-on-hover-click';127	}128	if ( 'always' === $computed_visibility ) {129		$classes[] = 'open-always';130	}131	if ( $is_active ) {132		$classes[] = 'current-menu-item';133	}134 135	$wrapper_attributes = get_block_wrapper_attributes(136		array(137			'class' => implode( ' ', $classes ),138		)139	);140 141	$label = '';142 143	if ( isset( $attributes['label'] ) ) {144		$label .= wp_kses_post( $attributes['label'] );145	}146 147	$aria_label = sprintf(148		/* translators: Accessibility text. %s: Parent page title. */149		__( '%s submenu' ),150		wp_strip_all_tags( $label )151	);152 153	$html = '<li ' . $wrapper_attributes . '>';154 155	// If Submenus open on hover or are always open, we render an anchor tag with attributes.

Changelog

Introduced in 5.9.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-submenu.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.