WordPress/gutenberg

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

Open

#15,731 创建于 2019年5月20日

在 GitHub 查看
 (5 评论) (1 反应) (0 负责人)JavaScript (9,607 star) (3,893 fork)batch import
Good First IssueNeeds Dev[Feature] Block API[Type] Developer Documentation

描述

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.

贡献者指南

技术栈
javascriptreact
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Basic WordPress development knowledge
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
80
研究方向
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`).