Description

Fixes #7150
No impact.

Type of change

• Sub-task of PHPStan - Ensure Docblock presence for wpm_apply_filters_typed() #7119
• Chore

Detailed scenario

None

Technical description

Documentation

This pull request adds a new PHPStan rule to enforce the usage of typed filters and includes tests to ensure its proper functionality. The most important changes include the addition of the new rule, updates to the PHPStan configuration, and the creation of test cases to validate the rule.

New Rule Addition:

• tests/phpstan/Rules/ApplyFiltersTypedDynamicFunctionReturnTypeExtension.php: Added a new PHPStan rule to enforce the use of wpm_apply_filters_typed with properly documented @param tags.

Configuration Updates:

• phpstan.neon.dist: Updated the PHPStan configuration to include the new rule WP_Rocket\Tests\phpstan\Rules\ApplyFiltersTypedDynamicFunctionReturnTypeExtension.
• phpstan-baseline.neon: Added a new baseline entry for the rule to handle invalid @param tags.

Test Cases:

• tests/phpstan/tests/Rules/ApplyFiltersTypedDynamicFunctionReturnTypeExtensionTest.php: Added test cases to validate the new rule, including tests for valid usage, missing types, wrong types, and missing docblocks.
• tests/phpstan/tests/data/ApplyFiltersTypedDynamicFunctionReturnTypeExtensionTest/missing-docblock.php: Added a test case for a missing docblock scenario.
• tests/phpstan/tests/data/ApplyFiltersTypedDynamicFunctionReturnTypeExtensionTest/missing-type.php: Added a test case for a missing type in the @param tag.
• tests/phpstan/tests/data/ApplyFiltersTypedDynamicFunctionReturnTypeExtensionTest/valid.php: Added a test case for valid usage of the wpm_apply_filters_typed function.
• tests/phpstan/tests/data/ApplyFiltersTypedDynamicFunctionReturnTypeExtensionTest/wrong-type.php: Added a test case for an incorrect type in the @param tag.

New dependencies

None

Risks

None

Mandatory Checklist

Code validation

• I validated all the Acceptance Criteria. If possible, provide screenshots or videos.
• I triggered all changed lines of code at least once without new errors/warnings/notices.
• I implemented built-in tests to cover the new/changed code.

Code style

• I wrote a self-explanatory code about what it does.
• I protected entry points against unexpected inputs.
• I did not introduce unnecessary complexity.
• Output messages (errors, notices, logs) are explicit enough for users to understand the issue and are actionnable.

Unticked items justification

WIP