block_core_navigation_get_submenu_visibility( array $attributes ): string
- Since
- 7.0.0
- Source
wp-includes/blocks/navigation.php:24
Description
This function centralizes the migration logic from the boolean openSubmenusOnClick to the new submenuVisibility enum.
Backward compatibility: WordPress applies default attribute values, so submenuVisibility will always have a value even for legacy blocks. We check the legacy openSubmenusOnClick attribute first to preserve original behavior for blocks saved before the migration.
Compatibility
- WordPress
- since 7.0.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in 2 of the 5 tracked releases, added in 7.0.0, and compiles on PHP 7.4 through 8.6-dev.
Parameters
$attributesarray- Block attributes containing submenuVisibility and/or openSubmenusOnClick.
Return value
string- The visibility mode: 'hover', 'click', or 'always'.
Performance profile
How much work a call to block_core_navigation_get_submenu_visibility() 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
- Scaling
- Constant
- Instructions
- 9–14
- Plugin surface
- None
- Called by
- 2
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 18.
Nothing here hands control to plugin code.
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_get_submenu_visibility() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 9–14 | none |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 18 instructions, 9–14 executed per call, 5 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.
Used by · 2
- WP_Navigation_Block_Renderer::is_interactive()Determine whether the navigation blocks is interactive.
- block_core_navigation_add_directives_to_submenu()Add Interactivity API directives to the navigation-submenu and page-list blocks markup using the Tag Processor.
Source code
function block_core_navigation_get_submenu_visibility( $attributes ) { $deprecated_open_submenus_on_click = $attributes['openSubmenusOnClick'] ?? null; // For backward compatibility, prioritize the legacy attribute if present. // Legacy blocks have openSubmenusOnClick in the database. Since WordPress applies // default values, submenuVisibility will also have a value, but we check the legacy // attribute first to preserve the original behavior. If the block has been updated // and saved in the editor, then the deprecated attribute will be replaced by submenuVisibility. if ( null !== $deprecated_open_submenus_on_click ) { // Convert boolean to string: true -> 'click', false -> 'hover'. return ! empty( $deprecated_open_submenus_on_click ) ? 'click' : 'hover'; } $submenu_visibility = $attributes['submenuVisibility'] ?? null; // Use submenuVisibility for migrated/new blocks (where openSubmenusOnClick is null). return $submenu_visibility ?? 'hover';}Changelog
Introduced in 7.0.0. Unchanged from 7.0.4 through 7.1.0.
Signature, return type and hooks compared across 2 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.