Navigation overlay close button may be displayed twice by getdave · Pull Request #76585 · WordPress/gutenberg

getdave · 2026-03-17T14:10:37Z

What

When a navigation overlay template part uses a pattern () that contained a close block, the close button was displayed twice - once for the close in the pattern and then a fallback. This PR fixes that.

Fixes #76567

Why

The fallback close button must only be shown when the overlay does not already contain a close block. The issue was that if the close block was within a Pattern the fallback detection logic failed to detect it thus leading to the duplication.

How

Detect the close block in the rendered overlay HTML using WP_HTML_Tag_Processor
Add block_core_navigation_overlay_html_has_close_block() helper
Suppress the fallback close button when the overlay HTML contains the close button element

Why not check the block tree?

Pattern blocks are self-closing in the tree (); their inner content is not expanded there. A check like block_core_navigation_block_tree_has_block_type() never sees the close block inside patterns, so it always reports "no close block" and the fallback is incorrectly added.

Why check rendered HTML?

When the block renders, patterns are resolved and their content is output. The close button appears in the actual HTML. Detecting it there (e.g. via WP_HTML_Tag_Processor) correctly reflects what the user sees. It also accounts for edge cases such as hooks/filters adding close blocks...etc

Testing Instructions

Create a block theme with a navigation overlay template part
Inline close block: Add  directly in the template part. Verify one close button appears.
Pattern with close block: Create a pattern containing the overlay content (including ). Use  in the template part. Verify one close button appears (not two).
No close block: Use an overlay without the close block. Verify the fallback close button appears.

Replace block tree check and pattern resolution with WP_HTML_Tag_Processor on rendered overlay HTML. Fixes double close button when overlay template parts use patterns. Fixes #76567

github-actions · 2026-03-17T14:13:52Z

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: getdave <get_dave@git.wordpress.org>
Co-authored-by: scruffian <scruffian@git.wordpress.org>
Co-authored-by: benoitchantre <benoitchantre@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

getdave · 2026-03-17T14:15:08Z

@benoitchantre would you be open to testing this fix to your reported bug?

You can test using Playground if that helps?

Copilot

Pull request overview

Fixes a Gutenberg navigation overlay rendering issue where the fallback close button could be output even when the overlay template part already renders a core/navigation-overlay-close block via a core/pattern, resulting in duplicate close buttons.

Changes:

Switch close-button detection from block-tree inspection to rendered overlay HTML inspection (via WP_HTML_Tag_Processor) to correctly handle pattern expansion.
Add block_core_navigation_overlay_html_has_close_block() helper for detecting the close button element in rendered overlay HTML.
Add PHPUnit coverage for the new HTML-based detection, including the pattern-rendering scenario that triggered #76567.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File	Description
`packages/block-library/src/navigation/index.php`	Detects overlay close presence from rendered HTML (works with patterns) and suppresses fallback close button accordingly.
`phpunit/blocks/class-wp-navigation-block-renderer-test.php`	Adds unit tests for the new rendered-HTML close-button detection helper, including pattern output coverage.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

phpunit/blocks/class-wp-navigation-block-renderer-test.php

github-actions · 2026-03-17T14:42:04Z

Flaky tests detected in ca8ba3e.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/23214188635
📝 Reported issues:

[Flaky Test] post title and content are editable and blocks can be inserted #76524 in /test/e2e/specs/editor/various/post-content-focus-mode.spec.js
[Flaky Test] should move focus back to the Publish panel toggle button when canceling #76179 in /test/e2e/specs/editor/various/publish-panel.spec.js

benoitchantre · 2026-03-17T20:08:07Z

@benoitchantre would you be open to testing this fix to your reported bug?

You can test using Playground if that helps?

It works! Thank you for the fix.

Tested with the provided Playground link and a custom theme under development.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

scruffian

Thanks for the fix. I can confirm it works with this test theme: WordPress/community-themes#263

* fix: Use HTML-based detection for navigation overlay close block Replace block tree check and pattern resolution with WP_HTML_Tag_Processor on rendered overlay HTML. Fixes double close button when overlay template parts use patterns. Fixes #76567 * fix: Apply PHP coding standards to navigation block renderer test * Apply suggestions from code review Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-authored-by: getdave <get_dave@git.wordpress.org> Co-authored-by: scruffian <scruffian@git.wordpress.org> Co-authored-by: benoitchantre <benoitchantre@git.wordpress.org>

github-actions · 2026-03-18T07:20:35Z

I just cherry-picked this PR to the wp/7.0 branch to get it included in the next release: f1ddd38

This updates the pinned hash from the `gutenberg` from `8c78d87453509661a9f28f978ba2c242d515563b` to `487a096a9782ba6110a7686d7b4b2d0c55ed1b06`. The following changes are included: - Disables anchor support for the Page Break block. (WordPress/gutenberg#76434) - WP Admin: Update Connectors screen footer text for consistency. (WordPress/gutenberg#76382) - E2E Tests: Add coverage for AI plugin callout banner on Connectors page (WordPress/gutenberg#76432) - Update sync docs (WordPress/gutenberg#75972) - RTC: Add preference for collaborator notifications (WordPress/gutenberg#76460) - Fix "should undo bold" flaky test (WordPress/gutenberg#76464) - TimePicker: Clamp month day to valid day for month (WordPress/gutenberg#76400) - RTC: Fix error when entity record doesn't have 'meta' property (WordPress/gutenberg#76311) - Navigation: Update close button size. (WordPress/gutenberg#76482) - TemplateContentPanel: fix useSelect warning (WordPress/gutenberg#76421) - DataViews: Add spinner in `DataViewsLayout` in initial load of data (WordPress/gutenberg#76486) (WordPress/gutenberg#76490) - RTC: Fix TypeError in areEditorStatesEqual when selection is undefined (WordPress/gutenberg#76163) - Page/Post Content Focus Mode: Fix insertion into Post Content block (WordPress/gutenberg#76477) - Revisions: use useSubRegistry={false} to fix global store selectors (WordPress/gutenberg#76152) (WordPress/gutenberg#76522) - Fix RTL styling on Connectors, Font Library, and boot-based admin pages (WordPress/gutenberg#76496) - RTC: Auto-register custom taxonomy rest_base values for CRDT sync (WordPress/gutenberg#75983) - RTC: Add a limit for the default provider (WordPress/gutenberg#76437) - Fix RTL styling on AI plugin callout banner (WordPress/gutenberg#76497) - Add command palette trigger button to admin bar (WordPress/gutenberg#75757) - Block Bindings: Remove source items constrained by enums (WordPress/gutenberg#76200) - HTML Block: Remove "unsaved changes" check (WordPress/gutenberg#76086) - CI: Don't build release notes during plugin build workflow for WP Core sync (WordPress/gutenberg#76398) (WordPress/gutenberg#76578) - CI: Simplify strategy matrix in Build Gutenberg Plugin Zip workflow (WordPress/gutenberg#76435) (WordPress/gutenberg#76538) - Media: Add hooks and extension points for client-side media processing (WordPress/gutenberg#74913) - RTC: Fix list sidebar reset during real-time collaboration (WordPress/gutenberg#76025) - RTC: Fix CRDT serialization of nested RichText attributes (WordPress/gutenberg#76597) - RTC: Remove post list lock icon and replace user-specific lock text (WordPress/gutenberg#76322) - Fix HEIC upload error handling and sub-size format (WordPress/gutenberg#76514) - RTC: Fix cursor index sync with rich text formatting (WordPress/gutenberg#76418) - RTC: Allow filtering of `SyncConnectionModal` (WordPress/gutenberg#76554) - RTC: Implement front-end peer limits (WordPress/gutenberg#76565) - Navigation overlay close button may be displayed twice (WordPress/gutenberg#76585) - Site Editor > Templates: fix author filter (WordPress/gutenberg#76625) - Revisions: Show changed block attributes in inspector sidebar (WordPress/gutenberg#76550) - Fix IS_GUTENBERG_PLUGIN env var override in build config (WordPress/gutenberg#76605) - Real Time Collaboration: Introduce filters for the polling intervals. (WordPress/gutenberg#76518) - RTC: Fix RichTextData deserialization (WordPress/gutenberg#76607) - Cross Origin Isolation: Remove `img` from the list of elements that get mutated (WordPress/gutenberg#76618) - RTC: Scroll to collaborator on click (WordPress/gutenberg#76561) - Update changelog link for pull request 11276 (WordPress/gutenberg#76638) - Fix backport changelog filename (WordPress/gutenberg#76651) - Build: Skip non-minified build for WASM-inlined workers (WordPress/gutenberg#76615) - RTC: Change RTC option name (WordPress/gutenberg#76643) - BlockListBlock: fix crash when selectedProps are null (WordPress/gutenberg#75826) - Build: Fix vips worker 404 when SCRIPT_DEBUG is true (WordPress/gutenberg#76657) - useMediaQuery: support in-iframe queries via new `WindowContext` (WordPress/gutenberg#76446) (WordPress/gutenberg#76660) - Refactor admin-ui Page component to use @wordpress/theme tokens and @wordpress/ui layout primitive (WordPress/gutenberg#75963) - Connectors: Improve accessibility (WordPress/gutenberg#76456) - Build: Remove unused JXL WASM module from vips worker (WordPress/gutenberg#76639) - Connectors: fix button size (WordPress/gutenberg#76582) - Compose: Implement useCopyToClipboard and useCopyOnClick with native clipboard API (WordPress/gutenberg#75723) (WordPress/gutenberg#76663) - Connectors: Fetch specific plugin instead of all plugins (WordPress/gutenberg#76594) - Revisions: Add Meta fields diff panel to document sidebar (WordPress/gutenberg#76341) - Loosen client-side media processing requirements (WordPress/gutenberg#76616) - Reduce the added halo for selected block. (WordPress/gutenberg#76619) - Connectors: Add unregisterConnector and upsert support (WordPress/gutenberg#76541) A full list of changes can be found on GitHub: https://github.com/WordPress/gutenberg/compare/8c78d87453509661a9f28f978ba2c242d515563b…487a096a9782ba6110a7686d7b4b2d0c55ed1b06. Log created with: git log --reverse --format="- %s" 8c78d87453509661a9f28f978ba2c242d515563b..487a096a9782ba6110a7686d7b4b2d0c55ed1b06 | sed 's|#\([0-9][0-9]*\)|https://github.com/WordPress/gutenberg/pull/\1|g; /github\.com\/WordPress\/gutenberg\/pull/!d' | pbcopy See #64595. git-svn-id: https://develop.svn.wordpress.org/trunk@62063 602fd350-edb4-49c9-b593-d223f7449a82

This updates the pinned hash from the `gutenberg` from `8c78d87453509661a9f28f978ba2c242d515563b` to `487a096a9782ba6110a7686d7b4b2d0c55ed1b06`. The following changes are included: - Disables anchor support for the Page Break block. (WordPress/gutenberg#76434) - WP Admin: Update Connectors screen footer text for consistency. (WordPress/gutenberg#76382) - E2E Tests: Add coverage for AI plugin callout banner on Connectors page (WordPress/gutenberg#76432) - Update sync docs (WordPress/gutenberg#75972) - RTC: Add preference for collaborator notifications (WordPress/gutenberg#76460) - Fix "should undo bold" flaky test (WordPress/gutenberg#76464) - TimePicker: Clamp month day to valid day for month (WordPress/gutenberg#76400) - RTC: Fix error when entity record doesn't have 'meta' property (WordPress/gutenberg#76311) - Navigation: Update close button size. (WordPress/gutenberg#76482) - TemplateContentPanel: fix useSelect warning (WordPress/gutenberg#76421) - DataViews: Add spinner in `DataViewsLayout` in initial load of data (WordPress/gutenberg#76486) (WordPress/gutenberg#76490) - RTC: Fix TypeError in areEditorStatesEqual when selection is undefined (WordPress/gutenberg#76163) - Page/Post Content Focus Mode: Fix insertion into Post Content block (WordPress/gutenberg#76477) - Revisions: use useSubRegistry={false} to fix global store selectors (WordPress/gutenberg#76152) (WordPress/gutenberg#76522) - Fix RTL styling on Connectors, Font Library, and boot-based admin pages (WordPress/gutenberg#76496) - RTC: Auto-register custom taxonomy rest_base values for CRDT sync (WordPress/gutenberg#75983) - RTC: Add a limit for the default provider (WordPress/gutenberg#76437) - Fix RTL styling on AI plugin callout banner (WordPress/gutenberg#76497) - Add command palette trigger button to admin bar (WordPress/gutenberg#75757) - Block Bindings: Remove source items constrained by enums (WordPress/gutenberg#76200) - HTML Block: Remove "unsaved changes" check (WordPress/gutenberg#76086) - CI: Don't build release notes during plugin build workflow for WP Core sync (WordPress/gutenberg#76398) (WordPress/gutenberg#76578) - CI: Simplify strategy matrix in Build Gutenberg Plugin Zip workflow (WordPress/gutenberg#76435) (WordPress/gutenberg#76538) - Media: Add hooks and extension points for client-side media processing (WordPress/gutenberg#74913) - RTC: Fix list sidebar reset during real-time collaboration (WordPress/gutenberg#76025) - RTC: Fix CRDT serialization of nested RichText attributes (WordPress/gutenberg#76597) - RTC: Remove post list lock icon and replace user-specific lock text (WordPress/gutenberg#76322) - Fix HEIC upload error handling and sub-size format (WordPress/gutenberg#76514) - RTC: Fix cursor index sync with rich text formatting (WordPress/gutenberg#76418) - RTC: Allow filtering of `SyncConnectionModal` (WordPress/gutenberg#76554) - RTC: Implement front-end peer limits (WordPress/gutenberg#76565) - Navigation overlay close button may be displayed twice (WordPress/gutenberg#76585) - Site Editor > Templates: fix author filter (WordPress/gutenberg#76625) - Revisions: Show changed block attributes in inspector sidebar (WordPress/gutenberg#76550) - Fix IS_GUTENBERG_PLUGIN env var override in build config (WordPress/gutenberg#76605) - Real Time Collaboration: Introduce filters for the polling intervals. (WordPress/gutenberg#76518) - RTC: Fix RichTextData deserialization (WordPress/gutenberg#76607) - Cross Origin Isolation: Remove `img` from the list of elements that get mutated (WordPress/gutenberg#76618) - RTC: Scroll to collaborator on click (WordPress/gutenberg#76561) - Update changelog link for pull request 11276 (WordPress/gutenberg#76638) - Fix backport changelog filename (WordPress/gutenberg#76651) - Build: Skip non-minified build for WASM-inlined workers (WordPress/gutenberg#76615) - RTC: Change RTC option name (WordPress/gutenberg#76643) - BlockListBlock: fix crash when selectedProps are null (WordPress/gutenberg#75826) - Build: Fix vips worker 404 when SCRIPT_DEBUG is true (WordPress/gutenberg#76657) - useMediaQuery: support in-iframe queries via new `WindowContext` (WordPress/gutenberg#76446) (WordPress/gutenberg#76660) - Refactor admin-ui Page component to use @wordpress/theme tokens and @wordpress/ui layout primitive (WordPress/gutenberg#75963) - Connectors: Improve accessibility (WordPress/gutenberg#76456) - Build: Remove unused JXL WASM module from vips worker (WordPress/gutenberg#76639) - Connectors: fix button size (WordPress/gutenberg#76582) - Compose: Implement useCopyToClipboard and useCopyOnClick with native clipboard API (WordPress/gutenberg#75723) (WordPress/gutenberg#76663) - Connectors: Fetch specific plugin instead of all plugins (WordPress/gutenberg#76594) - Revisions: Add Meta fields diff panel to document sidebar (WordPress/gutenberg#76341) - Loosen client-side media processing requirements (WordPress/gutenberg#76616) - Reduce the added halo for selected block. (WordPress/gutenberg#76619) - Connectors: Add unregisterConnector and upsert support (WordPress/gutenberg#76541) A full list of changes can be found on GitHub: https://github.com/WordPress/gutenberg/compare/8c78d87453509661a9f28f978ba2c242d515563b…487a096a9782ba6110a7686d7b4b2d0c55ed1b06. Log created with: git log --reverse --format="- %s" 8c78d87453509661a9f28f978ba2c242d515563b..487a096a9782ba6110a7686d7b4b2d0c55ed1b06 | sed 's|#\([0-9][0-9]*\)|https://github.com/WordPress/gutenberg/pull/\1|g; /github\.com\/WordPress\/gutenberg\/pull/!d' | pbcopy See #64595. Built from https://develop.svn.wordpress.org/trunk@62063 git-svn-id: http://core.svn.wordpress.org/trunk@61345 1a063a9b-81f0-0310-95a4-ce76da25c4cd

fix: Use HTML-based detection for navigation overlay close block

6145c44

Replace block tree check and pattern resolution with WP_HTML_Tag_Processor on rendered overlay HTML. Fixes double close button when overlay template parts use patterns. Fixes #76567

github-actions bot added the [Package] Block library /packages/block-library label Mar 17, 2026

getdave added [Type] Bug An existing feature does not function as intended [Block] Navigation Affects the Navigation Block [Feature] Navigation Overlays labels Mar 17, 2026

getdave added this to WordPress 7.0 Editor Tasks Mar 17, 2026

github-project-automation bot moved this to 🔎 Needs Review in WordPress 7.0 Editor Tasks Mar 17, 2026

getdave added the Backport to WP 7.0 Beta/RC Pull request that needs to be backported to the WordPress major release that's currently in beta label Mar 17, 2026

getdave removed this from WordPress 7.0 Editor Tasks Mar 17, 2026

fix: Apply PHP coding standards to navigation block renderer test

d9f20ca

getdave self-assigned this Mar 17, 2026

getdave requested review from jeryj and scruffian March 17, 2026 14:13

getdave marked this pull request as ready for review March 17, 2026 14:13

getdave requested review from ajitbohra and fabiankaegy as code owners March 17, 2026 14:13

getdave requested a review from Copilot March 17, 2026 14:15

Copilot started reviewing on behalf of getdave March 17, 2026 14:15 View session

Copilot AI reviewed Mar 17, 2026

View reviewed changes

phpunit/blocks/class-wp-navigation-block-renderer-test.php Outdated Show resolved Hide resolved

phpunit/blocks/class-wp-navigation-block-renderer-test.php Outdated Show resolved Hide resolved

Apply suggestions from code review

ca8ba3e

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

scruffian approved these changes Mar 17, 2026

View reviewed changes

getdave merged commit 0c33c5c into trunk Mar 18, 2026
39 of 40 checks passed

getdave deleted the fix/navigation-overlay-html-close-detection branch March 18, 2026 07:19

github-actions bot added this to the Gutenberg 22.8 milestone Mar 18, 2026

github-actions bot removed the Backport to WP 7.0 Beta/RC Pull request that needs to be backported to the WordPress major release that's currently in beta label Mar 18, 2026

github-actions bot added the Backported to WP Core Pull request that has been successfully merged into WP Core label Mar 18, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Navigation overlay close button may be displayed twice#76585

Navigation overlay close button may be displayed twice#76585
getdave merged 3 commits intotrunkfrom
fix/navigation-overlay-html-close-detection

getdave commented Mar 17, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Mar 17, 2026 •

edited

Loading

Uh oh!

getdave commented Mar 17, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Mar 17, 2026 •

edited

Loading

Uh oh!

benoitchantre commented Mar 17, 2026

Uh oh!

scruffian left a comment

Uh oh!

Uh oh!

github-actions bot commented Mar 18, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

getdave commented Mar 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What

Why

How

Why not check the block tree?

Why check rendered HTML?

Testing Instructions

Uh oh!

github-actions bot commented Mar 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

getdave commented Mar 17, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Mar 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

benoitchantre commented Mar 17, 2026

Uh oh!

scruffian left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions bot commented Mar 18, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

getdave commented Mar 17, 2026 •

edited

Loading

github-actions bot commented Mar 17, 2026 •

edited

Loading

github-actions bot commented Mar 17, 2026 •

edited

Loading