WordPress/gutenberg

Documentation: Clarify the behavior of parent when empty during block registration

Open

#15731 opened on May 20, 2019

View on GitHub
 (5 comments) (1 reaction) (0 assignees)JavaScript (9,607 stars) (3,893 forks)batch import
Good First IssueNeeds Dev[Feature] Block API[Type] Developer Documentation

Description

Part of https://github.com/WordPress/gutenberg/issues/41236.

Describe the bug

https://developer.wordpress.org/block-editor/developers/block-api/block-registration/#parent-optional

It might be good to update the documentation here to clarify that you can restrict it to the root if you pass an empty array. (Also good to check if there are tests for this or if it just happens to work.)

This also leads to the question what the default is for this parameter. undefined? null? In any case just "Type: Array" doesn't seem correct.

Contributor guide

Tech stack
javascriptreact
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic WordPress development knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Investigate the behavior of the `parent` property in block registration by examining the source code in the Gutenberg repository (e.g., `packages/blocks/src/api/registration.js`). Look for existing tests that cover the empty array case. Update the documentation on developer.wordpress.org to clearly state that an empty array restricts the block to the root, and document the default value (e.g., `undefined`).