WordPress/gutenberg

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

Open

#15.731 geöffnet am 20. Mai 2019

Auf GitHub ansehen
 (5 Kommentare) (1 Reaktion) (0 zugewiesene Personen)JavaScript (9.607 Stars) (3.893 Forks)batch import
Good First IssueNeeds Dev[Feature] Block API[Type] Developer Documentation

Beschreibung

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
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Basic WordPress development knowledge
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80
Research-Richtung
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`).