block_core_navigation_get_fallback_blocks(): array
- Since
- 5.9.0
- Source
wp-includes/blocks/navigation.php:1479
Description
This aims to mirror how the fallback mechanic for wp_nav_menu works.
See https://developer.wordpress.org/reference/functions/wp_nav_menu/#more-information.
Compatibility
- WordPress
- since 5.9.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.
Return value
array- the array of blocks to be used as a fallback.
Performance profile
How much work a call to block_core_navigation_get_fallback_blocks() 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
- Scaling
- Constant
- Instructions
- 18–47
- Plugin surface
- 1 hook
- Called by
- 1
Reaches the database via get_post().
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 49.
Third-party callbacks on 'block_core_navigation_render_fallback' run inside this call, and their cost is not bounded by anything here.
1 place in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()called directly - querycontent query
get_post()one call below block_core_navigation_get_fallback_blocks()
Further down the call graph this can also reach cache, serialize, option 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 · 2 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost block_core_navigation_get_fallback_blocks() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 18–19 | ::WP_Block_Type_Registry(), ->is_registered(), ::WP_Navigation_Fallback(), apply_filters() |
| always | 45–47 | ::WP_Block_Type_Registry(), ->is_registered(), ::WP_Navigation_Fallback(), parse_blocks(), block_core_navigation_filter_out_empty_blocks(), serialize_blocks(), apply_block_hooks_to_content_from_post_object(), parse_blocks(), apply_filters() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 49 instructions, 18–47 executed per call, 3 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.
Hooks and filters fired · 1
One hook fires while block_core_navigation_get_fallback_blocks() runs, in this order:
- apply_filters( block_core_navigation_render_fallback )filterline 1523 (+44 into the body)
Filters the fallback experience for the Navigation block.
Uses · 7
- parse_blocks()Parses blocks out of a content string.
- block_core_navigation_filter_out_empty_blocks()Filter out empty "null" blocks from the block list.
- serialize_blocks()Returns a joined string of the aggregate serialization of the given parsed blocks.
- apply_block_hooks_to_content_from_post_object()Run the Block Hooks algorithm on a post object's content.
- apply_filters()Calls the callback functions that have been added to a filter hook.
- WP_Block_Type_Registry::get_instance()Utility method to retrieve the main instance of the class.
- WP_Navigation_Fallback::get_fallback()Gets (and/or creates) an appropriate fallback Navigation Menu.
Used by · 1
- WP_Navigation_Block_Renderer::get_inner_blocks_from_fallback()Gets the inner blocks for the navigation block from the fallback.
Source code
function block_core_navigation_get_fallback_blocks() { $page_list_fallback = array( array( 'blockName' => 'core/page-list', 'innerContent' => array(), 'attrs' => array(), ), ); $registry = WP_Block_Type_Registry::get_instance(); // If `core/page-list` is not registered then return empty blocks. $fallback_blocks = $registry->is_registered( 'core/page-list' ) ? $page_list_fallback : array(); $navigation_post = WP_Navigation_Fallback::get_fallback(); // Use the first non-empty Navigation as fallback if available. if ( $navigation_post ) { $parsed_blocks = parse_blocks( $navigation_post->post_content ); $maybe_fallback = block_core_navigation_filter_out_empty_blocks( $parsed_blocks ); // Normalizing blocks may result in an empty array of blocks if they were all `null` blocks. // In this case default to the (Page List) fallback. $fallback_blocks = ! empty( $maybe_fallback ) ? $maybe_fallback : $fallback_blocks; // Run Block Hooks algorithm to inject hooked blocks. // We have to run it here because we need the post ID of the Navigation block to track ignored hooked blocks. // TODO: See if we can move the apply_block_hooks_to_content_from_post_object() call // before the parse_blocks() call further above, to avoid the extra serialization/parsing. $markup = serialize_blocks( $fallback_blocks ); $markup = apply_block_hooks_to_content_from_post_object( $markup, $navigation_post ); $fallback_blocks = parse_blocks( $markup ); } /** * Filters the fallback experience for the Navigation block. * * Returning a falsey value will opt out of the fallback and cause the block not to render. * To customise the blocks provided return an array of blocks - these should be valid * children of the `core/navigation` block. * * @since 5.9.0 * * @param array[] $fallback_blocks default fallback blocks provided by the default block mechanic. */ return apply_filters( 'block_core_navigation_render_fallback', $fallback_blocks );}Changelog
Introduced in 5.9.0. Unchanged from 6.7.7 through 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.