Documentation: Adds clarifications and clears up inaccuracies #46283
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mburridge
requested review from
ajitbohra,
ryanwelcher,
juanmaguitar and
fabiankaegy
as code owners
mburridge
added
[Type] Developer Documentation
alexstine
reviewed
Dec 2, 2022
| @@ -29,15 +29,15 @@ registerBlockType( metadata.name, { | |||
| } ); | |||
| ``` | |||
|
|
|||
| The first parameter in the **registerBlockType** function is the block name, this should match exactly to the name registered in the PHP file. | |||
| The first parameter in the **registerBlockType** function is the block name, this should match exactly to the `name` property in the `block.json` file. By importing the metadata from `block.json` and referencing the `name` property in the first parameter we ensure that they will match, and continue to match even if the name is subsecquently changed in `block.json`. | |||
There was a problem hiding this comment.
Suggested change
| The first parameter in the **registerBlockType** function is the block name, this should match exactly to the `name` property in the `block.json` file. By importing the metadata from `block.json` and referencing the `name` property in the first parameter we ensure that they will match, and continue to match even if the name is subsecquently changed in `block.json`. | |
| The first parameter in the **registerBlockType** function is the block name, this should match exactly to the `name` property in the `block.json` file. By importing the metadata from `block.json` and referencing the `name` property in the first parameter we ensure that they will match, and continue to match even if the name is subsequently changed in `block.json`. |
There was a problem hiding this comment.
Good catch, thanks @alexstine
ryanwelcher
approved these changes
Dec 2, 2022
There was a problem hiding this comment.
Thanks for putting this together @mburridge. I made one small change to add a comma, but otherwise LGTM!
Co-authored-by: Ryan Welcher <me@ryanwelcher.com>
|
This one good to go now? If so, feel free to re-run the pesky failing tests and merge. Flaky tests. |
ryanwelcher
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
Fixes inaccurate reference to the name being registered in the PHP file and corrects it to reference the
nameproperty in theme.json.Fixes inaccurate implication that
setAttributesgets passed to thesavefunction.Adds some clarifications around both items.
Why?
To remove inaccurate/misleading information and provide clarification.