Table Of Contents: Include headings exclusively within the core/post-content block
#69366
Conversation
This file contains hidden or 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
|
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 If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
Mamaduka
reviewed
Mar 3, 2025
13f9d73 to
4aa0eb4
Compare
Mamaduka
approved these changes
Mar 4, 2025
|
@yogeshbhutkar, rebasing on top of the lastest trunk should resolve e2e test failures. |
4aa0eb4 to
ec6801e
Compare
chriszarate
pushed a commit
to chriszarate/gutenberg
that referenced
this pull request
Jul 1, 2025
…-content` block (WordPress#69366) Co-authored-by: yogeshbhutkar <yogeshbhutkar@git.wordpress.org> Co-authored-by: Mamaduka <mamaduka@git.wordpress.org> Co-authored-by: ryelle <ryelle@git.wordpress.org>
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?
Closes #69359
This PR updates the logic to ensure the
Table of Contentsblock only considersHeadingelements within thecore/post-contentblock. Previously, it included all headings on the page, including those in theHeaderandFooter, which could lead to unintended results.Why?
Including
Headingelements from outside thecore/post-contentblock—such as those in theHeaderandFooter—in theTable of Contentsblock is not ideal, as it should strictly focus on the main content. The block should serve its intended purpose of summarizing the structure of the post by tabulating only theHeadingtags used within the post content.How?
The previous implementation used
getClientIdsWithDescendantsto get the client IDs of all the blocks in the editor. When theShow Templatemode is toggled (template-lockedediting mode ), this selector literally returns all the blocks within the editor. That includes theHeader,Footer, and the blocks within theTemplate. This behavior causes the bug mentioned above.The current PR updates the usage to use
getClientIdsOfDescendantsto exclusively get the nested blocks within thepost-contentusing itsClient ID. If theClient IDbecomes undefined or an empty string for some reason ( e.g. when editing mode is set to post-only ), in such a scenario, it gracefully falls back to return thetop-levelblocks.Testing Instructions
Headingelements to theHeader,Footer, or within theTemplate.Headingelements inside the post content.Header,Footer, orTemplate.Screenshots
Testing edge cases
