Skip to content

Constants/RestrictedConstants: minor improvements #869

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 30, 2025
Merged

Constants/RestrictedConstants: minor improvements #869

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d5e5c27
Constants/RestrictedConstants: minor efficiency fix
jrfnl Jul 23, 2025
43e02ff
Constants/RestrictedConstants: fix nonsensical comparison
jrfnl Jul 20, 2025
169a74e
Constants/RestrictedConstants: use PHPCSUtils `TextStrings::stripQuot…
jrfnl Jul 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 35 additions & 5 deletions WordPressVIPMinimum/Sniffs/Constants/RestrictedConstantsSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
namespace WordPressVIPMinimum\Sniffs\Constants;

use PHP_CodeSniffer\Util\Tokens;
use PHPCSUtils\Utils\TextStrings;
use WordPressVIPMinimum\Sniffs\Sniff;

/**
Expand All @@ -36,12 +37,39 @@ class RestrictedConstantsSniff extends Sniff {
'WP_CRON_CONTROL_SECRET',
];

/**
* List of (global) constant names, which should not be referenced in userland code, nor (re-)declared.
*
* {@internal The `public` versions of these properties can't be removed until the next major,
* though a decision is still needed whether they should be removed at all.
* Also see: Automattic/VIP-Coding-Standards#234 for more context and discussion about this.}
*
* @var array<string, int> Key is the constant name, value is irrelevant.
*/
private $restrictedConstants = [];

/**
* List of (global) constants, which should not be (re-)declared, but may be referenced.
*
* {@internal The `public` versions of these properties can't be removed until the next major,
* though a decision is still needed whether they should be removed at all.
* Also see: Automattic/VIP-Coding-Standards#234 for more context and discussion about this.}
*
* @var array<string, int> Key is the constant name, value is irrelevant.
*/
private $restrictedRedeclaration = [];

/**
* Returns an array of tokens this test wants to listen for.
*
* @return array<int|string>
*/
public function register() {
// For now, set the `private` properties based on the values of the `public` properties.
// This should be revisited when Automattic/VIP-Coding-Standards#234 gets actioned.
$this->restrictedConstants = array_flip( $this->restrictedConstantNames );
$this->restrictedRedeclaration = array_flip( $this->restrictedConstantDeclaration );

return [
T_CONSTANT_ENCAPSED_STRING,
T_STRING,
Expand All @@ -60,15 +88,17 @@ public function process_token( $stackPtr ) {
if ( $this->tokens[ $stackPtr ]['code'] === T_STRING ) {
$constantName = $this->tokens[ $stackPtr ]['content'];
} else {
$constantName = trim( $this->tokens[ $stackPtr ]['content'], "\"'" );
$constantName = TextStrings::stripQuotes( $this->tokens[ $stackPtr ]['content'] );
}

if ( in_array( $constantName, $this->restrictedConstantNames, true ) === false && in_array( $constantName, $this->restrictedConstantDeclaration, true ) === false ) {
if ( isset( $this->restrictedConstants[ $constantName ] ) === false
&& isset( $this->restrictedRedeclaration[ $constantName ] ) === false
) {
// Not the constant we are looking for.
return;
}

if ( $this->tokens[ $stackPtr ]['code'] === T_STRING && in_array( $constantName, $this->restrictedConstantNames, true ) === true ) {
if ( $this->tokens[ $stackPtr ]['code'] === T_STRING && isset( $this->restrictedConstants[ $constantName ] ) === true ) {
$message = 'Code is touching the `%s` constant. Make sure it\'s used appropriately.';
$data = [ $constantName ];
$this->phpcsFile->addWarning( $message, $stackPtr, 'UsingRestrictedConstant', $data );
Expand Down Expand Up @@ -97,12 +127,12 @@ public function process_token( $stackPtr ) {
return;
}

if ( in_array( $this->tokens[ $previous ]['code'], Tokens::$functionNameTokens, true ) === true ) {
if ( $this->tokens[ $previous ]['code'] === T_STRING ) {
$data = [ $constantName ];
if ( $this->tokens[ $previous ]['content'] === 'define' ) {
$message = 'The definition of `%s` constant is prohibited. Please use a different name.';
$this->phpcsFile->addError( $message, $previous, 'DefiningRestrictedConstant', $data );
} elseif ( in_array( $constantName, $this->restrictedConstantNames, true ) === true ) {
} elseif ( isset( $this->restrictedConstants[ $constantName ] ) === true ) {
$message = 'Code is touching the `%s` constant. Make sure it\'s used appropriately.';
$this->phpcsFile->addWarning( $message, $previous, 'UsingRestrictedConstant', $data );
}
Expand Down
4 changes: 3 additions & 1 deletion WordPressVIPMinimum/Tests/Constants/RestrictedConstantsUnitTest.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,6 @@ if ( defined( 'JETPACK_DEV_DEBUG' ) ) { // Okay. Can touch.

if ( constant( 'WP_CRON_CONTROL_SECRET' ) ) { // Okay. Can touch.

}
}

define( '"A8C_PROXIED_REQUEST"', false ); // Okay, well not really as the name is not a valid PHP constant name, but that's not our concern.