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`).