block_core_shared_navigation_item_should_render( array $attributes, WP_Block $block ): bool
- Since
- 7.0.0
- Source
wp-includes/blocks/navigation-link/shared/item-should-render.php:17
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- The block attributes.
$blockWP_Block- The parsed block.
Return value
bool- True if the item should render, false otherwise.
Performance profile
How much work a call to block_core_shared_navigation_item_should_render() 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
- 12–43
- Plugin surface
- 1 hook
- Called by
- 2
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 44.
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.
2 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- querycontent query
get_post()called directly - hookthird-party callbacks
apply_filters()called directly
Further down the call graph this can also reach option, 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 · 2 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost block_core_shared_navigation_item_should_render() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 12–25 | none |
| always | 27–43 | get_post(), apply_filters() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 44 | 12–43 | 9 | |
| 8.5 | 44 | 12–43 | 9 | |
| 8.4 | 44 | 12–43 | 9 | 5 fewer instructions than PHP 8.3 |
| 8.3 | 49 | 12–48 | 9 | |
| 8.2 | 49 | 12–48 | 9 | |
| 8.1 | 49 | 12–48 | 9 | 1 fewer instruction than PHP 7.4 |
| 7.4 | 50 | 12–49 | 9 |
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_shared_navigation_item_should_render() runs, in this order:
- apply_filters( render_block_core_navigation_link_allowed_post_status )filterline 34 (+17 into the body)
Filter allowed post_status for navigation link block to render.
Uses · 2
- 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.
Used by · 2
- render_block_core_navigation_link()Renders the `core/navigation-link` block.
- render_block_core_navigation_submenu()Renders the `core/navigation-submenu` block.
Source code
function block_core_shared_navigation_item_should_render( $attributes, $block ) { $navigation_link_has_id = isset( $attributes['id'] ) && is_numeric( $attributes['id'] ); $is_post_type = isset( $attributes['kind'] ) && 'post-type' === $attributes['kind']; $is_post_type = $is_post_type || isset( $attributes['type'] ) && ( 'post' === $attributes['type'] || 'page' === $attributes['type'] ); // Don't render the block's subtree if it is a draft or if the ID does not exist. if ( $is_post_type && $navigation_link_has_id ) { $post = get_post( $attributes['id'] ); /** * Filter allowed post_status for navigation link block to render. * * @since 6.8.0 * * @param array $post_status Array of allowed post statuses. * @param array $attributes Block attributes. * @param WP_Block $block The parsed block. */ $allowed_post_status = (array) apply_filters( 'render_block_core_navigation_link_allowed_post_status', array( 'publish' ), $attributes, $block ); if ( ! $post || ! in_array( $post->post_status, $allowed_post_status, true ) ) { return false; } } return true;}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-link/shared/item-should-render.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.