Navigation Block: Prevent circular references in navigation block rendering #46387
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 5 commits
December 7, 2022 15:14
ajlende
added
[Type] Bug
ajlende
requested review from
draganescu,
scruffian,
getdave and
MaggieCabrera
ajlende
force-pushed
the
revert-46279-nav-inner-block-recursion-rerendering
branch
from
7668d55 to
cc64fd6
Compare
ajlende
commented
Dec 8, 2022
Comment on lines
+585
to
+588
| if ( in_array( $attributes['ref'], $seen_ref, true ) ) { | ||
| return ''; | ||
| } | ||
| $seen_ref[] = $attributes['ref']; |
There was a problem hiding this comment.
This could be smarter and keep track of the parent rather than a flat array so you could have two identical sibling navigation blocks, but Navigation blocks probably shouldn't be nested inside other navigation blocks in the first place, so it's probably fine this way.
There was a problem hiding this comment.
This ended up not being fine. #47085
ajlende
commented
Dec 8, 2022
Comment on lines
+682
to
+716
| $list_item_nav_blocks = array( | ||
| 'core/navigation-link', | ||
| 'core/home-link', | ||
| 'core/site-title', | ||
| 'core/site-logo', | ||
| 'core/navigation-submenu', | ||
| ); | ||
|
|
||
| $needs_list_item_wrapper = array( | ||
| 'core/site-title', | ||
| 'core/site-logo', | ||
| ); | ||
|
|
||
| $inner_blocks_html = ''; | ||
| $is_list_open = false; | ||
| foreach ( $inner_blocks as $inner_block ) { | ||
| if ( ( 'core/navigation-link' === $inner_block->name || 'core/home-link' === $inner_block->name || 'core/site-title' === $inner_block->name || 'core/site-logo' === $inner_block->name || 'core/navigation-submenu' === $inner_block->name ) && ! $is_list_open ) { | ||
| $is_list_item = in_array( $inner_block->name, $list_item_nav_blocks, true ); | ||
|
|
||
| if ( $is_list_item && ! $is_list_open ) { | ||
| $is_list_open = true; | ||
| $inner_blocks_html .= '<ul class="wp-block-navigation__container">'; | ||
| } | ||
| if ( 'core/navigation-link' !== $inner_block->name && 'core/home-link' !== $inner_block->name && 'core/site-title' !== $inner_block->name && 'core/site-logo' !== $inner_block->name && 'core/navigation-submenu' !== $inner_block->name && $is_list_open ) { | ||
|
|
||
| if ( ! $is_list_item && $is_list_open ) { | ||
| $is_list_open = false; | ||
| $inner_blocks_html .= '</ul>'; | ||
| } | ||
|
|
||
| $inner_block_content = $inner_block->render(); | ||
| if ( 'core/site-title' === $inner_block->name || ( 'core/site-logo' === $inner_block->name && $inner_block_content ) ) { | ||
| $inner_blocks_html .= '<li class="wp-block-navigation-item">' . $inner_block_content . '</li>'; | ||
| } else { | ||
| $inner_blocks_html .= $inner_block_content; | ||
| if ( ! empty( $inner_block_content ) ) { | ||
| if ( in_array( $inner_block->name, $needs_list_item_wrapper, true ) ) { | ||
| $inner_blocks_html .= '<li class="wp-block-navigation-item">' . $inner_block_content . '</li>'; | ||
| } else { | ||
| $inner_blocks_html .= $inner_block_content; | ||
| } |
There was a problem hiding this comment.
The rest of this is refactoring as I was trying to make sense of the render function.
|
Size Change: +289 B (0%) Total Size: 1.32 MB
ℹ️ View Unchanged
|
draganescu
approved these changes
Dec 8, 2022
There was a problem hiding this comment.
Excellent work @ajlende This PR fixes recursion in terms of a navigation block containing the same navigation block but unlike the PR it reverts it allows a different navigation block to be nested. However this should be OK, since in my testing if the ref of the nested navigation block is different it will just render, no errors triggered.
scruffian
reviewed
Dec 8, 2022
scruffian
approved these changes
Dec 8, 2022
getdave
reviewed
Dec 8, 2022
scruffian
deleted the
revert-46279-nav-inner-block-recursion-rerendering
branch
ryanwelcher
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
Alternative to #46279. Fixes potential infinite recursion due to a circular reference while rendering
core/navigationblocks that reference themselves within the post_content of thewp_navigationpost.Why?
This approach doesn't modify block content while rendering.
How?
Testing Instructions
Before (validate the bug)
wp_navigationposts and Classic Menus from your sitepost_contentof yourwp_navigationpost with the following content, being sure to replace%%REPLACE_ME%%with the ID of thewp_navigationpost YOU just created:After (validate the bug)
Please try this with variations of content being sure that it contains the self-referential Nav block issue.
Testing Instructions for Keyboard
Screenshots or screencast