Issue-867: Update class constructor docblocks to support specifying an array
or a string
for $label
#869
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.
Summary
This pull request updates class constructor docblocks to accurately reflect that
$label
can be either anarray
or astring
. This change aims to address issues with code quality tools likephpstan
that arise due to the current incorrect specification of$label
as a string only. Fixes #867Background
Each constructor within the project has a
$label
parameter, which, according to the current docblocks, accepts only a string. This has been identified as incorrect since$label
can also be an array. The mismatch between the implementation and the documentation causes tools likephpstan
to report errors, potentially affecting code quality assurance processes.Changes
$label
can be either astring
or anarray
.Testing
phpstan
on a project that utilizeswordpress-fieldmanager
.array
for$label
, to simulate the scenario that previously led to errors.phpstan
to ensure that it no longer reports errors regarding the type of$label
.Additional Notes
This change is categorized as an enhancement rather than a bug fix, as it primarily aims to improve compatibility with code quality tools without altering the functionality of the existing codebase.
References
array
or astring
for$label
#867