render_block_core_navigation_link( 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_link() 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

69–131

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

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_link()
• hookthird-party callbacksapply_filters()one call below render_block_core_navigation_link()
• optionoption read or writeget_option()one call below render_block_core_navigation_link()

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 · 54 distinct outcomes

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

• 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.
• 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.
• esc_url()Checks and cleans a URL.
• block_core_navigation_link_maybe_urldecode()Decodes a url if it's encoded, returning the same url if not.
• esc_attr()Escaping for HTML attributes.
• wp_kses_post()Sanitizes content for allowed HTML tags for post content.
• block_core_shared_navigation_render_submenu_icon()Returns the submenu SVG chevron icon.

Source code

View on Trac ↗View on GitHub ↗

187function render_block_core_navigation_link( $attributes, $content, $block ) {188	// Check if this navigation item should render based on post status.189	if ( defined( 'IS_GUTENBERG_PLUGIN' ) && IS_GUTENBERG_PLUGIN ) {190		$should_render = gutenberg_block_core_shared_navigation_item_should_render( $attributes, $block );191	} else {192		$should_render = block_core_shared_navigation_item_should_render( $attributes, $block );193	}194	if ( ! $should_render ) {195		return '';196	}197 198	// Don't render the block's subtree if it has no label.199	if ( empty( $attributes['label'] ) ) {200		return '';201	}202 203	$classes = array();204 205	// Render inner blocks first to check if any menu items will actually display.206	$inner_blocks_html = '';207	foreach ( $block->inner_blocks as $inner_block ) {208		$inner_blocks_html .= $inner_block->render();209	}210	$has_submenu = ! empty( trim( $inner_blocks_html ) );211 212	$css_classes = trim( implode( ' ', $classes ) );213	$kind        = empty( $attributes['kind'] ) ? 'post_type' : str_replace( '-', '_', $attributes['kind'] );214	$is_active   = ! empty( $attributes['id'] ) && get_queried_object_id() === (int) $attributes['id'] && ! empty( get_queried_object()->$kind );215 216	if ( is_post_type_archive() && ! empty( $attributes['url'] ) ) {217		$queried_archive_link = get_post_type_archive_link( get_queried_object()->name );218		if ( $attributes['url'] === $queried_archive_link ) {219			$is_active = true;220		}221	}222 223	$wrapper_attributes = get_block_wrapper_attributes(224		array(225			'class' => $css_classes . ' wp-block-navigation-item' . ( $has_submenu ? ' has-child' : '' ) .226				( $is_active ? ' current-menu-item' : '' ),227		)228	);229	$html               = '<li ' . $wrapper_attributes . '>' .230		'<a class="wp-block-navigation-item__content" ';231 232	// Start appending HTML attributes to anchor tag.233	if ( isset( $attributes['url'] ) ) {234		$html .= ' href="' . esc_url( block_core_navigation_link_maybe_urldecode( $attributes['url'] ) ) . '"';235	}236 237	if ( $is_active ) {238		$html .= ' aria-current="page"';239	}240 241	if ( isset( $attributes['opensInNewTab'] ) && true === $attributes['opensInNewTab'] ) {242		$html .= ' target="_blank"  ';243	}244 245	if ( isset( $attributes['rel'] ) ) {246		$html .= ' rel="' . esc_attr( $attributes['rel'] ) . '"';247	} elseif ( isset( $attributes['nofollow'] ) && $attributes['nofollow'] ) {248		$html .= ' rel="nofollow"';249	}250 251	if ( isset( $attributes['title'] ) ) {252		$html .= ' title="' . esc_attr( $attributes['title'] ) . '"';253	}254 255	// End appending HTML attributes to anchor tag.256 257	// Start anchor tag content.258	$html .= '>' .259		// Wrap title with span to isolate it from submenu icon.260		'<span class="wp-block-navigation-item__label">';261 262	if ( isset( $attributes['label'] ) ) {263		$html .= wp_kses_post( $attributes['label'] );264	}265 266	$html .= '</span>';

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