Skip to content

WP/GetMetaSingle: simplify code using two class constants #2631

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

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from
+50 −84
Open

WP/GetMetaSingle: simplify code using two class constants #2631

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e331fe6
WP/GetMetaSingle: simplify code using two class constants
rodrigoprimo Aug 5, 2025
a09975d
Fix version number in since tags
rodrigoprimo Oct 17, 2025
e53d4f9
Change the order of the two class constants
rodrigoprimo Oct 20, 2025
e3672da
Add `private` visibility to the two new constants
rodrigoprimo Oct 20, 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
134 changes: 50 additions & 84 deletions WordPress/Sniffs/WP/GetMetaSingleSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,48 @@ final class GetMetaSingleSniff extends AbstractFunctionParameterSniff {
*/
const METRIC_NAME = 'get_*meta() function called with $single parameter';

/**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can the order of these constants please be reversed ?

To me, the logical order would be to go from generic to more specific.
And even if that would be too arbitrary, we could use alphabetical order and that would still result in the same: the GENERIC_META_FUNCTIONS_FORMAT first, the SPECIFIC_META_FUNCTIONS_FORMAT constant second.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done, I pushed a new commit reversing the order.

* Relevant signature structure for generic meta functions.
*
* These functions use 'meta_key' as the parameter name at position 3 and
* 'single' as the parameter name at position 4.
*
* @since 3.3.0
*
* @var array<string, array<string, int|string>>
*/
private const GENERIC_META_FUNCTIONS_FORMAT = array(
'condition' => array(
'param_name' => 'meta_key',
'position' => 3,
),
'recommended' => array(
'param_name' => 'single',
'position' => 4,
),
);

/**
* Relevant signature structure for specific meta functions.
*
* These functions use 'key' as the parameter name at position 2 and
* 'single' as the parameter name at position 3.
*
* @since 3.3.0
*
* @var array<string, array<string, int|string>>
*/
private const SPECIFIC_META_FUNCTIONS_FORMAT = array(
'condition' => array(
'param_name' => 'key',
'position' => 2,
),
'recommended' => array(
'param_name' => 'single',
'position' => 3,
),
);

/**
* The group name for this group of functions.
*
Expand All @@ -45,10 +87,6 @@ final class GetMetaSingleSniff extends AbstractFunctionParameterSniff {
/**
* List of functions this sniff should examine.
*
* {@internal Once support for PHP < 5.6 is dropped, it is possible to create two class constants
* representing the two different signatures of get meta functions to remove the duplication
* of the name and position of the parameters.}
*
* @link https://developer.wordpress.org/reference/functions/get_comment_meta/
* @link https://developer.wordpress.org/reference/functions/get_metadata/
* @link https://developer.wordpress.org/reference/functions/get_metadata_default/
Expand All @@ -66,86 +104,14 @@ final class GetMetaSingleSniff extends AbstractFunctionParameterSniff {
* the relevant parameters.
*/
protected $target_functions = array(
'get_comment_meta' => array(
'condition' => array(
'param_name' => 'key',
'position' => 2,
),
'recommended' => array(
'param_name' => 'single',
'position' => 3,
),
),
'get_metadata' => array(
'condition' => array(
'param_name' => 'meta_key',
'position' => 3,
),
'recommended' => array(
'param_name' => 'single',
'position' => 4,
),
),
'get_metadata_default' => array(
'condition' => array(
'param_name' => 'meta_key',
'position' => 3,
),
'recommended' => array(
'param_name' => 'single',
'position' => 4,
),
),
'get_metadata_raw' => array(
'condition' => array(
'param_name' => 'meta_key',
'position' => 3,
),
'recommended' => array(
'param_name' => 'single',
'position' => 4,
),
),
'get_post_meta' => array(
'condition' => array(
'param_name' => 'key',
'position' => 2,
),
'recommended' => array(
'param_name' => 'single',
'position' => 3,
),
),
'get_site_meta' => array(
'condition' => array(
'param_name' => 'key',
'position' => 2,
),
'recommended' => array(
'param_name' => 'single',
'position' => 3,
),
),
'get_term_meta' => array(
'condition' => array(
'param_name' => 'key',
'position' => 2,
),
'recommended' => array(
'param_name' => 'single',
'position' => 3,
),
),
'get_user_meta' => array(
'condition' => array(
'param_name' => 'key',
'position' => 2,
),
'recommended' => array(
'param_name' => 'single',
'position' => 3,
),
),
'get_comment_meta' => self::SPECIFIC_META_FUNCTIONS_FORMAT,
'get_metadata' => self::GENERIC_META_FUNCTIONS_FORMAT,
'get_metadata_default' => self::GENERIC_META_FUNCTIONS_FORMAT,
'get_metadata_raw' => self::GENERIC_META_FUNCTIONS_FORMAT,
'get_post_meta' => self::SPECIFIC_META_FUNCTIONS_FORMAT,
'get_site_meta' => self::SPECIFIC_META_FUNCTIONS_FORMAT,
'get_term_meta' => self::SPECIFIC_META_FUNCTIONS_FORMAT,
'get_user_meta' => self::SPECIFIC_META_FUNCTIONS_FORMAT,
);

/**
Expand Down
Loading