Add PHPCS ruleset from Plugin Check and fix issues #2048

westonruter · 2025-06-10T01:17:40Z

Fixes #2043
Fixes #2049

codecov · 2025-06-10T01:27:08Z

Codecov Report

Attention: Patch coverage is 77.77778% with 2 lines in your changes missing coverage. Please review.

Project coverage is 68.03%. Comparing base (77d137f) to head (4c06a40).
Report is 18 commits behind head on trunk.

Files with missing lines	Patch %	Lines
plugins/performance-lab/includes/admin/load.php	0.00%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##            trunk    #2048      +/-   ##
==========================================
+ Coverage   68.02%   68.03%   +0.01%     
==========================================
  Files          92       92              
  Lines        7627     7631       +4     
==========================================
+ Hits         5188     5192       +4     
  Misses       2439     2439

Flag	Coverage Δ
multisite	`68.03% <77.77%> (+0.01%)`	⬆️
single	`37.02% <77.77%> (+0.03%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

westonruter · 2025-06-10T02:11:47Z

plugins/performance-lab/includes/admin/load.php

@@ -305,7 +305,7 @@ function perflab_install_activate_plugin_callback(): void {
 		wp_die( esc_html__( 'Missing required parameter.', 'performance-lab' ) );
 	}

-	$plugin_slug = perflab_sanitize_plugin_slug( wp_unslash( $_GET['slug'] ) );
+	$plugin_slug = perflab_sanitize_plugin_slug( wp_unslash( $_GET['slug'] ) ); // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- perflab_sanitize_plugin_slug() is a sanitizing function.


As an alternative to this, the function could be added to customUnslashingSanitizingFunctions, but then Plugin Check wouldn't know about it.

On the other hand, I don't think Plugin Check handles phpcs:ignore comments, so it won't have an effect there.

Related: WordPress/plugin-check#901

I guess then it's still better to have these comments because if a plugin reviewer looks at the line they can at least see the explanatory comment.

composer.json

github-actions · 2025-06-10T02:43:28Z

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: westonruter <[email protected]>
Co-authored-by: swissspidy <[email protected]>
Co-authored-by: ShyamGadde <[email protected]>
Co-authored-by: pmbaldha <[email protected]>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

plugins/optimization-detective/storage/class-od-storage-lock.php

…ertions

composer.json

tools/phpcs/phpcs.ruleset.xml

swissspidy · 2025-06-10T08:46:31Z

tools/phpcs/plugin-check.ruleset.xml

+	<!-- For more information: https://make.wordpress.org/plugins/handbook/review/ -->
+	<description>Standards any plugin to be published on wordpress.org should comply with.</description>
+
+	<!-- The following rules have been copied from https://github.com/WordPress/plugin-check/blob/95c426228a23a3b290de7758a1708e95fd3c5345/phpcs-rulesets/plugin-review.xml#L33-L174 -->


Instead of copying the file, can we just reference it in phpcs.ruleset.xml from vendor/[...]/plugin-check/phpcs-rulesets/plugin-review.xml?

Good question. I thought about this but I didn't try it because that ruleset includes other rules which we don't want, namely:

https://github.com/WordPress/plugin-check/blob/95c426228a23a3b290de7758a1708e95fd3c5345/phpcs-rulesets/plugin-review.xml#L7-L31

The config <config name="testVersion" value="5.2-"/> is causing a lot of failures in PHPCompatibility. I just tried.

It would be nice if there was a base ruleset in PCP which plugin-review.xml included that we could also include.

I see, makes sense.

Yeah there might be ways to make that easier. Can't hurt to open an issue there with this suggestion 👍

Good idea. Opened: WordPress/plugin-check#966

swissspidy · 2025-06-10T13:53:18Z

The changes here are nice for local development. For CI, it might be easier to just use https://github.com/WordPress/plugin-check-action

Co-authored-by: swissspidy <[email protected]>

westonruter · 2025-06-10T14:04:23Z

For CI, it might be easier to just use https://github.com/WordPress/plugin-check-action

I thought about that, but the only concern there would be duplication in the failures, right? Also, if PCP ignores phpcs:ignore comments then this would be problematic, right?

swissspidy · 2025-06-11T14:32:04Z

I thought about that, but the only concern there would be duplication in the failures, right?

Yes there would be duplication. So probably have to pick one or the other.

Also, if PCP ignores phpcs:ignore comments then this would be problematic, right?

It depends. PCP Is the source of truth after all, as that's what's being run on dotorg for plugin submissions (and eventually updates)

ShyamGadde

LGTM - went through the diff and everything looks good to me, nothing further from my side. 👍

Add XML Schema to PHPCS rulesets

c69a0b2

westonruter added [Type] Bug An existing feature is broken no milestone PRs that do not have a defined milestone for release skip changelog PRs that should not be mentioned in changelogs labels Jun 10, 2025

westonruter added 2 commits June 9, 2025 18:29

Add plugin-check as dependency and incorporate ruleset

03e197f

Fix issues in performance-lab

dbbdb0e

westonruter force-pushed the fix/phpcs branch from 1e04d8a to dbbdb0e Compare June 10, 2025 01:30

westonruter added 2 commits June 9, 2025 19:10

Exclude irrelevant sniffs from tests

159255b

Add validation and sanitization to string which will be hashed anyway

c707828

westonruter commented Jun 10, 2025

View reviewed changes

composer.json Show resolved Hide resolved

Exclude phpunit bootstrap from security sniffs

da29440

westonruter mentioned this pull request Jun 10, 2025

Address errors reported by Plugin Check #2043

Closed

westonruter marked this pull request as ready for review June 10, 2025 02:43

westonruter requested review from felixarntz, adamsilverstein, pbearne, joemcgill, mukeshpanchal27 and manuelRod as code owners June 10, 2025 02:43

westonruter commented Jun 10, 2025

View reviewed changes

plugins/optimization-detective/storage/class-od-storage-lock.php Show resolved Hide resolved

Incorporate rest_is_ip_address() for key computation and add test ass…

5713919

…ertions

westonruter added this to the performance-lab n.e.x.t milestone Jun 10, 2025

westonruter removed the no milestone PRs that do not have a defined milestone for release label Jun 10, 2025

swissspidy reviewed Jun 10, 2025

View reviewed changes

composer.json Outdated Show resolved Hide resolved

swissspidy reviewed Jun 10, 2025

View reviewed changes

tools/phpcs/phpcs.ruleset.xml Show resolved Hide resolved

swissspidy reviewed Jun 10, 2025

View reviewed changes

westonruter mentioned this pull request Jun 10, 2025

Comply the Optimization Detective Plugin with the Plugin Check (PCP) Plugin #2049

Closed

westonruter and others added 2 commits June 10, 2025 06:54

Explain why the PCP ruleset is copied

830a30c

Improve repositories configuration in composer.json

fd5a0bd

Co-authored-by: swissspidy <[email protected]>

westonruter mentioned this pull request Jun 10, 2025

Ruleset should be made available for plugins to reference WordPress/plugin-check#966

Open

westonruter and others added 3 commits June 10, 2025 07:08

Run composer update and add validation to lint-staged

fbffd15

Merge branch 'trunk' into fix/phpcs

b66d57a

Remove erroneous ext-curl from fbffd15

4c06a40

westonruter requested a review from ShyamGadde June 13, 2025 00:24

ShyamGadde approved these changes Jun 13, 2025

View reviewed changes

westonruter merged commit b4b2eca into trunk Jun 13, 2025
20 of 21 checks passed

westonruter deleted the fix/phpcs branch June 13, 2025 13:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add PHPCS ruleset from Plugin Check and fix issues #2048

Add PHPCS ruleset from Plugin Check and fix issues #2048

westonruter commented Jun 10, 2025 •

edited

Loading

Uh oh!

codecov bot commented Jun 10, 2025 •

edited

Loading

Uh oh!

westonruter Jun 10, 2025

Uh oh!

swissspidy Jun 10, 2025

Uh oh!

westonruter Jun 10, 2025

Uh oh!

Uh oh!

github-actions bot commented Jun 10, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

swissspidy Jun 10, 2025

Uh oh!

westonruter Jun 10, 2025 •

edited

Loading

Uh oh!

swissspidy Jun 10, 2025

Uh oh!

westonruter Jun 10, 2025

Uh oh!

swissspidy commented Jun 10, 2025

Uh oh!

westonruter commented Jun 10, 2025

Uh oh!

swissspidy commented Jun 11, 2025

Uh oh!

ShyamGadde left a comment

Uh oh!

Uh oh!

Uh oh!

Add PHPCS ruleset from Plugin Check and fix issues #2048

Add PHPCS ruleset from Plugin Check and fix issues #2048

Conversation

westonruter commented Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

westonruter Jun 10, 2025

Choose a reason for hiding this comment

Uh oh!

swissspidy Jun 10, 2025

Choose a reason for hiding this comment

Uh oh!

westonruter Jun 10, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions bot commented Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

swissspidy Jun 10, 2025

Choose a reason for hiding this comment

Uh oh!

westonruter Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

swissspidy Jun 10, 2025

Choose a reason for hiding this comment

Uh oh!

westonruter Jun 10, 2025

Choose a reason for hiding this comment

Uh oh!

swissspidy commented Jun 10, 2025

Uh oh!

westonruter commented Jun 10, 2025

Uh oh!

swissspidy commented Jun 11, 2025

Uh oh!

ShyamGadde left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

westonruter commented Jun 10, 2025 •

edited

Loading

codecov bot commented Jun 10, 2025 •

edited

Loading

github-actions bot commented Jun 10, 2025 •

edited

Loading

westonruter Jun 10, 2025 •

edited

Loading