WP_Navigation_Block_Renderer::get_overlay_blocks_from_template_part( string $overlay_template_part_id, array $attributes ): WP_Block_List

Compatibility

Present in 2 of the 5 tracked releases, added in 6.5.0, and compiles on PHP 7.4 through 8.6-dev.

Parameters

$overlay_template_part_idstring

The overlay template part ID in format "theme//slug".

$attributesarray

The block attributes.

Return value

WP_Block_List

Returns the inner blocks for the overlay template part.

Performance profile

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

Constant

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

Instructions

9–94

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

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_overlay_blocks_from_template_part()
• optionoption read or writeget_option()one call below WP_Navigation_Block_Renderer::get_overlay_blocks_from_template_part()
• querycontent queryget_post()one call below WP_Navigation_Block_Renderer::get_overlay_blocks_from_template_part()

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 · 19 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_overlay_blocks_from_template_part() can have, taken from its control-flow graph on PHP 8.5.

Uses · 12

• get_stylesheet()Retrieves name of the current stylesheet.
• get_block_file_template()Retrieves a unified template object based on a theme file or plugin registration.
• shortcode_unautop()Don't auto-p wrap shortcodes that stand alone.
• do_shortcode()Searches content for shortcodes and filter shortcodes through their hooks.
• 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.
• _build_block_template_result_from_post()Builds a unified template object based a post Object.
• 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.
• WP_Block_List::__construct()Constructor.
• WP_Query::__construct()Constructor.
• static::disable_overlay_menu_for_nested_navigation_blocks()

Source code

View on Trac ↗View on GitHub ↗

417	private static function get_overlay_blocks_from_template_part( $overlay_template_part_id, $attributes ) {418		if ( empty( $overlay_template_part_id ) || ! is_string( $overlay_template_part_id ) ) {419			return new WP_Block_List( array(), $attributes );420		}421 422		// Parse the template part ID (format: "theme//slug").423		// If it's just a slug, construct the full ID using the current theme.424		$parts = explode( '//', $overlay_template_part_id, 2 );425		if ( count( $parts ) === 2 ) {426			// Already in "theme//slug" format (backward compatibility).427			$theme = $parts[0];428			$slug  = $parts[1];429		} else {430			// Just a slug, use current theme.431			$theme = get_stylesheet();432			$slug  = $overlay_template_part_id;433		}434 435		// Only query for template parts from the active theme.436		if ( get_stylesheet() !== $theme ) {437			return new WP_Block_List( array(), $attributes );438		}439 440		// Query for the template part post.441		$template_part_query = new WP_Query(442			array(443				'post_type'           => 'wp_template_part',444				'post_status'         => 'publish',445				'post_name__in'       => array( $slug ),446				'tax_query'           => array(447					array(448						'taxonomy' => 'wp_theme',449						'field'    => 'name',450						'terms'    => $theme,451					),452				),453				'posts_per_page'      => 1,454				'no_found_rows'       => true,455				'lazy_load_term_meta' => false, // Do not lazy load term meta, as template parts only have one term.456			)457		);458 459		$template_part_post = $template_part_query->have_posts() ? $template_part_query->next_post() : null;460 461		if ( ! $template_part_post ) {462			// Try to get from theme file if not in database.463			// Construct the full template part ID for get_block_file_template.464			$full_template_part_id = $theme . '//' . $slug;465			$block_template        = get_block_file_template( $full_template_part_id, 'wp_template_part' );466			if ( isset( $block_template->content ) ) {467				// Expand shortcodes before parsing blocks, matching the order in468				// `render_block_core_template_part()`.469				$content       = shortcode_unautop( $block_template->content );470				$content       = do_shortcode( $content );471				$parsed_blocks = parse_blocks( $content );472				$blocks        = block_core_navigation_filter_out_empty_blocks( $parsed_blocks );473				// Disable overlay menu for any navigation blocks within the overlay to prevent nested overlays.474				$blocks = static::disable_overlay_menu_for_nested_navigation_blocks( $blocks );475				return new WP_Block_List( $blocks, $attributes );476			}477			return new WP_Block_List( array(), $attributes );478		}479 480		// Get the template part content.481		$block_template = _build_block_template_result_from_post( $template_part_post );482		if ( ! isset( $block_template->content ) ) {483			return new WP_Block_List( array(), $attributes );484		}485 486		$parsed_blocks = parse_blocks( $block_template->content );487 488		// 'parse_blocks' includes a null block with '\n\n' as the content when489		// it encounters whitespace. This code strips it.490		$blocks = block_core_navigation_filter_out_empty_blocks( $parsed_blocks );491 492		// Re-serialize, and run Block Hooks algorithm to inject hooked blocks.493		$markup = serialize_blocks( $blocks );494		$markup = apply_block_hooks_to_content_from_post_object( $markup, $template_part_post );495 496		// Expand shortcodes before parsing blocks, matching the order in

Changelog

Introduced in 6.5.0. Unchanged from 7.0.4 through 7.1.0.

1. 7.0.4
2. 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.