Skip to content

Docs: Clarify parent behavior during block registration#78967

Open
SMITGHORI wants to merge 1 commit into
WordPress:trunkfrom
SMITGHORI:docs/clarify-parent-empty-array
Open

Docs: Clarify parent behavior during block registration#78967
SMITGHORI wants to merge 1 commit into
WordPress:trunkfrom
SMITGHORI:docs/clarify-parent-empty-array

Conversation

@SMITGHORI
Copy link
Copy Markdown

What?

Closes

Why?

How?

Testing Instructions

Testing Instructions for Keyboard

Screenshots or screencast

Before After

Use of AI Tools

Copilot AI review requested due to automatic review settings June 5, 2026 04:58
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Jun 5, 2026

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.

  • Required label: Any label starting with [Type].
  • Labels found: .

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.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Jun 5, 2026

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.

Unlinked Accounts

The 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.

Unlinked contributors: SMITGHORI.


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

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 parent default as undefined and clarified behavior when omitted.
  • Clarified that parent restricts 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.
Comment on lines 278 to +279
- **Type:** `Array`
- **Default:** `undefined`
@github-actions github-actions Bot added the First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository label Jun 5, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Jun 5, 2026

👋 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.

@SMITGHORI
Copy link
Copy Markdown
Author

Docs: Clarify parent behavior during block registration

@t-hamano t-hamano added the [Type] Developer Documentation Documentation for developers label Jun 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository [Type] Developer Documentation Documentation for developers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants