Skip to content

Exclude the wp-compat false positive from the PHPStan config - #343

Open
swissspidy wants to merge 1 commit into
mainfrom
fix/phpstan-wp-compat
Open

Exclude the wp-compat false positive from the PHPStan config#343
swissspidy wants to merge 1 commit into
mainfrom
fix/phpstan-wp-compat

Conversation

@swissspidy

@swissspidy swissspidy commented Aug 25, 2026

Copy link
Copy Markdown
Member

The johnbillion/wp-compat PHPStan extension that now ships with wp-cli-tests checks every WordPress symbol against the WordPress 4.9 baseline that wp-cli-tests configures. It reported exactly one error here, and it is a false positive.

Where Reported Why it is a false positive
src/WP_CLI/Core/CoreUpgrader.php:61 Parameter $args of apply_filters() is only available since WordPress version 6.0.0 WordPress 6.0 only "formalized the existing and already documented ...$args parameter by adding it to the function signature". Before that, apply_filters() collected additional arguments through func_get_args(), so passing the extra arguments to upgrader_pre_download has always worked

Ignored by error identifier and path, with the reason documented.

No source changes: nothing here is an actual compatibility problem.

Verification

Run locally against the same dependency versions CI resolves (johnbillion/wp-compat 2.0.0, php-stubs/wordpress-stubs v6.9.4, wp-cli/wp-cli-tests v5.2.3):

  • composer phpstan[OK] No errors
  • As a control, adding a deliberately dead ignore entry does produce an ignore.unmatched error, confirming the entry above matches a real error rather than sitting there unused

GitHub Actions was failing to allocate runners across the org while this was written, so CI may need a re-run once that clears.


Generated by Claude Code

Summary by CodeRabbit

  • Chores
    • Updated static analysis configuration to account for a known WordPress compatibility warning.
    • Added documentation clarifying the relevant WordPress version context.

The johnbillion/wp-compat extension that comes with wp-cli-tests checks every
WordPress symbol against the WordPress 4.9 baseline that wp-cli-tests
configures. It reported a single error, and it is a false positive: WordPress
6.0 merely formalized the already documented `...$args` parameter of
`apply_filters()` by adding it to the function signature, so passing extra
arguments to `upgrader_pre_download` has always worked.

Co-authored-by: Pascal Birchler <pascal.birchler@gmail.com>
@swissspidy
swissspidy requested a review from a team as a code owner August 25, 2026 20:56
Copilot AI lite review requested due to automatic review settings August 25, 2026 20:56

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@coderabbitai

coderabbitai Bot commented Aug 25, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 821ef797-2857-4ae0-851f-499b3af09e18

📥 Commits

Reviewing files that changed from the base of the PR and between 52041f6 and 0a6e625.

📒 Files selected for processing (1)
  • phpstan.neon.dist

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The PHPStan configuration adds an ignore rule for a WordPress compatibility diagnostic related to the variadic apply_filters() parameter in CoreUpgrader.php.

Changes

PHPStan compatibility

Layer / File(s) Summary
Add WordPress compatibility ignore rule
phpstan.neon.dist
The configuration ignores WPCompat.parameterNotAvailable.applyfilters.args for CoreUpgrader.php and documents the related WordPress version context.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to 0a6e6

This change excludes one documented PHPStan false positive without altering runtime behavior, and the reported analysis passes; no actionable merge-blocking risk remains after normal checks and review.

Suggested reviewers: brianhenryie

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: excluding a WP compatibility false positive from the PHPStan configuration.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/phpstan-wp-compat

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions github-actions Bot added automated-pr scope:testing Related to testing labels Aug 25, 2026
@codecov

codecov Bot commented Aug 25, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@swissspidy swissspidy added this to the 3.0.2 milestone Aug 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants