Move "global variable" related utilities to dedicated WPGlobalVariablesHelper
#2159
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
jrfnl
commented
Dec 19, 2022
…lesHelper`
The "global variable" related utilities are only used by a small number of sniffs, so are better placed in a dedicated class.
This commit moves the `$wp_globals` property to a new `WordPressCS\WordPress\Helpers\WPGlobalVariablesHelper` and starts using that class in the relevant sniffs.
Note:
* The property is now `private` (and `static`).
This protects the property against inadvertent changes.
* Access to the property can be obtained via the new `WPGlobalVariablesHelper::get_names()` method.
* Alternatively, the new `WPGlobalVariablesHelper::is_wp_global()` method can be used to check is a given variable name is the name of a WP global variable.
Related to 1465
jrfnl
force-pushed
the
feature/move-wp-global-list-to-helper-class
branch
from
00b3764
to
38152a4
Compare
dingo-d
approved these changes
Dec 20, 2022
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.
The "global variable" related utilities are only used by a small number of sniffs, so are better placed in a dedicated class.
This commit moves the
$wp_globalsproperty to a newWordPressCS\WordPress\Helpers\WPGlobalVariablesHelperand starts using that class in the relevant sniffs.Note:
private(andstatic). This protects the property against inadvertent changes.WPGlobalVariablesHelper::get_names()method.WPGlobalVariablesHelper::is_wp_global()method can be used to check if a given variable name is the name of a WP global variable.Related to #1465