PHP 8.3 typed class constants: add tests to two sniffs #2547
+27
−1
Conversation
This file contains hidden or 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
…tant type This commit modifies one of the existing class constants in the code used in the `WordPress.NamingConventions.PrefixAllGlobal` tests to have a type. This is just to ensure that there is a test for typed class constants added in PHP 8.3 as this sniff listens to the `T_CONST` token. The sniff was already handling typed class constants correctly and no change to the sniff code is needed.
This commit adds a few tests using type class constants to the `WordPress.WP.CapitalPDangit` tests. This is just to ensure that the part of the sniff code that checks for `T_CONST` tokens to ignore constant declarations using the `const` keyword works correctly with typed class constants added in PHP 8.3. The sniff was already handling typed class constants correctly, and no change to the sniff code is needed.
jrfnl
approved these changes
Jul 19, 2025
| @@ -231,3 +231,16 @@ echo Some\Enum\WordPress::ENUM_CONSTANT; | |||
|
|
|||
| // Safeguard that the sniff doesn't act on anonymous classes. | |||
| $anon = new class() {}; | |||
|
|
|||
| /* | |||
| * Safeguard that PHP 8.3+ typed class constants are handled correctly. | |||
There was a problem hiding this comment.
Suggested change
| * Safeguard that PHP 8.3+ typed class constants are handled correctly. | |
| * Safeguard that PHP 8.3+ typed class constants are handled correctly (i.e. ignored). |
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.
Typed class constants were introduced in PHP 8.3 (https://wiki.php.net/rfc/typed_class_constants). PHPCS started supporting it in version 3.9.0 (PHPCSStandards/PHP_CodeSniffer#321). Since WPCS requires PHPCS 3.13.x, with @jrfnl's help, I investigated what needed to be updated in the WPCS repository to accommodate this new syntax.
In this PR, I'm adding tests to
WordPress.NamingConventions.PrefixAllGlobalsandWordPress.WP.CapitalPDangitto safeguard that those two sniffs continue to handle type class constants correctly, as both sniffs use theT_CONSTtoken. No changes were required to the code of those sniffs.ConstantsHelper::is_use_of_global_constant()andAbstractClassRestrictionsSniffwill need to be changed as well to support typed class constants. This will be addressed in another PR. For now, I documented this task in #2546.