Docs: Clarify parent behavior during block registration#78967
Conversation
|
Warning: Type of PR label mismatch To merge this PR, it requires exactly 1 label indicating the type of PR. Other labels are optional and not being checked here.
Read more about Type labels in Gutenberg. Don't worry if you don't have the required permissions to add labels; the PR reviewer should be able to help with the task. |
|
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 Unlinked AccountsThe following contributors have not linked their GitHub and WordPress.org accounts: @SMITGHORI. Contributors, please read how to link your accounts to ensure your work is properly credited in WordPress releases. 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. |
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates the parent option documentation for block registration to better describe direct-parent restrictions, clarify behavior when omitted, and document the empty-array behavior.
Changes:
- Documented
parentdefault asundefinedand clarified behavior when omitted. - Clarified that
parentrestricts direct parent blocks and updated the example wording. - Added documentation and an example for using
parent: []to restrict insertion to the top level.
| parent: [ 'core/columns' ], | ||
| ``` | ||
|
|
||
| Setting `parent` to an empty array restricts the block to the root level only, so it is not available inside another block. |
| - **Type:** `Array` | ||
| - **Default:** `undefined` |
|
👋 Thanks for your first Pull Request and for helping build the future of Gutenberg and WordPress, @SMITGHORI! In case you missed it, we'd love to have you join us in our Slack community. If you want to learn more about WordPress development in general, check out the Core Handbook full of helpful information. |
|
Docs: Clarify parent behavior during block registration |
What?
Closes
Why?
How?
Testing Instructions
Testing Instructions for Keyboard
Screenshots or screencast
Use of AI Tools