Document the naming convention for block-library PHP functions
#53777
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
anton-vlasenko
requested review from
gziolo,
tellthemachines,
ironprogrammer,
hellofromtonya,
azaozz and
ockham
anton-vlasenko
added
the
[Type] Developer Documentation
gziolo
approved these changes
Aug 18, 2023
packages/block-library/README.md
Outdated
| @@ -119,4 +119,23 @@ To find out more about contributing to this package or Gutenberg as a whole, ple | |||
| } | |||
| ``` | |||
|
|
|||
| ### Naming convention for PHP functions | |||
|
|
|||
| All PHP function names within the subdirectories of the `packages/block-library/src/` directory should start with one of the following prefixes: | |||
There was a problem hiding this comment.
Should it be clarified that it applies to function definitions? Example:
Suggested change
| All PHP function names within the subdirectories of the `packages/block-library/src/` directory should start with one of the following prefixes: | |
| All declared PHP function names within the subdirectories of the `packages/block-library/src/` directory should start with one of the following prefixes: |
There was a problem hiding this comment.
Good catch. Fixed in 0586c63.
anton-vlasenko
deleted the
update/document-naming-convention-for-block-library-php-functions
branch
Thank you for the code review, @gziolo. I appreciate it. |
12 tasks
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?
This PR is intended to document the following naming convention: #52769 (comment).
Fixes #53732.
Why?
Documenting every naming convention is essential.
How?
ValidBlockLibraryFunctionNameSniff.Testing Instructions
Please review the suggested changes for accuracy, grammar, and style errors.
Testing Instructions for Keyboard
Screenshots or screencast