Enforce checks against redeclaration for functions and classes #50042
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
changed the title
anton-vlasenko
force-pushed
the
add/guard-functions-and-classes-sniff
branch
3 times, most recently
from
da087cf
to
118e136
Compare
anton-vlasenko
requested review from
TimothyBJacobs,
spacedmonkey and
geriux
as code owners
anton-vlasenko
requested review from
noisysocks,
adamziel,
gziolo,
hellofromtonya,
ironprogrammer and
azaozz
anton-vlasenko
added
[Type] Code Quality
Guard WP_Html_Span. Guard classes against redeclaration. Master is the main branch now. Fix CS errors.
anton-vlasenko
force-pushed
the
add/guard-functions-and-classes-sniff
branch
from
8944922
to
2cd039c
Compare
anton-vlasenko
commented
May 1, 2023
| </property> | ||
| <property name="classesWhiteList" type="array"> | ||
| <element value="/^Gutenberg.+/"/> | ||
| <element value="/^WP_.+_Gutenberg$/"/> |
There was a problem hiding this comment.
The question is: should classes like WP_Some_Class_Name_Gutenberg be allowed? I suppose it's quite unlikely that the _Gutenberg suffix won't be removed during backporting to Core, so I would say it's fine to whitelist such classes.
|
Closed in favour of #52696. |
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 pull request introduces checks that prevent redeclaration of Gutenberg classes and functions. More information about this can be found here: https://github.com/WordPress/gutenberg/blob/trunk/lib/README.md#wrap-functions-and-classes-with--function_exists-and--class_exists
Fixes #44151
Why?
Currently, Gutenberg allows to define PHP functions (classes) with any prefix.
This repeatedly resulted in fatal errors due to naming conflicts between Core and Gutenberg.
How?
To avoid these conflicts, this pull request adds a new
Gutenberg.CodeAnalysis.GuardedFunctionAndClassNamessniff tophpcs.xml.dist.This sniff verifies that the functions and classes are properly guarded.
Testing Instructions
Please don't merge this PR for now. Why?
https://github.com/anton-vlasenko/Gutenberg-Coding-Standards/ is for reviewing purposes only.