render_block_core_navigation_link( array $attributes, string $content, WP_Block $block ): string

Compatibility

Present in every tracked release (6.7.10 to 7.1.3), 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

Scales with input

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

Instructions

83–146

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

Plugin surface

1 hook

Third-party callbacks on 'render_block_core_navigation_link_allowed_post_status' run inside this call, and their cost is not bounded by anything here.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• querycontent queryget_post()called directly
• hookthird-party callbacksapply_filters()called directly
• 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 · 36 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.

Hooks and filters fired · 1

One hook fires while render_block_core_navigation_link() runs, in this order:

1. 1
   apply_filters( render_block_core_navigation_link_allowed_post_status )filterline 189 (+17 into the body)

   Filter allowed post_status for navigation link block to render.

Uses · 13

• get_post()Retrieves post data given a post ID or post object.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• block_core_navigation_link_build_css_font_sizes()Build an array with CSS classes and inline styles defining the font sizes which will be applied to the navigation markup in the front-end.
• 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.

Source code

View on Trac ↗View on GitHub ↗

172function render_block_core_navigation_link( $attributes, $content, $block ) {173	$navigation_link_has_id = isset( $attributes['id'] ) && is_numeric( $attributes['id'] );174	$is_post_type           = isset( $attributes['kind'] ) && 'post-type' === $attributes['kind'];175	$is_post_type           = $is_post_type || isset( $attributes['type'] ) && ( 'post' === $attributes['type'] || 'page' === $attributes['type'] );176 177	// Don't render the block's subtree if it is a draft or if the ID does not exist.178	if ( $is_post_type && $navigation_link_has_id ) {179		$post = get_post( $attributes['id'] );180		/**181		 * Filter allowed post_status for navigation link block to render.182		 *183		 * @since 6.8.0184		 *185		 * @param array $post_status186		 * @param array $attributes187		 * @param WP_Block $block188		 */189		$allowed_post_status = (array) apply_filters(190			'render_block_core_navigation_link_allowed_post_status',191			array( 'publish' ),192			$attributes,193			$block194		);195		if ( ! $post || ! in_array( $post->post_status, $allowed_post_status, true ) ) {196			return '';197		}198	}199 200	// Don't render the block's subtree if it has no label.201	if ( empty( $attributes['label'] ) ) {202		return '';203	}204 205	$font_sizes      = block_core_navigation_link_build_css_font_sizes( $block->context );206	$classes         = array_merge(207		$font_sizes['css_classes']208	);209	$style_attribute = $font_sizes['inline_styles'];210 211	$css_classes = trim( implode( ' ', $classes ) );212	$has_submenu = count( $block->inner_blocks ) > 0;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() ) {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			'style' => $style_attribute,228		)229	);230	$html               = '<li ' . $wrapper_attributes . '>' .231		'<a class="wp-block-navigation-item__content" ';232 233	// Start appending HTML attributes to anchor tag.234	if ( isset( $attributes['url'] ) ) {235		$html .= ' href="' . esc_url( block_core_navigation_link_maybe_urldecode( $attributes['url'] ) ) . '"';236	}237 238	if ( $is_active ) {239		$html .= ' aria-current="page"';240	}241 242	if ( isset( $attributes['opensInNewTab'] ) && true === $attributes['opensInNewTab'] ) {243		$html .= ' target="_blank"  ';244	}245 246	if ( isset( $attributes['rel'] ) ) {247		$html .= ' rel="' . esc_attr( $attributes['rel'] ) . '"';248	} elseif ( isset( $attributes['nofollow'] ) && $attributes['nofollow'] ) {249		$html .= ' rel="nofollow"';250	}251

Changelog

Introduced in 5.9.0. Unchanged from 6.7.10 through 7.1.3.

1. 6.7.10
2. 6.8.11
3. 6.9.10
4. 7.0.7
5. 7.1.3

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.8.11 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.