Skip to content

Commit d0140c8

Browse files
authored
Merge pull request #2557 from WordPress/feature/changelog-3.2.0
Changelog for the release of WordPressCS 3.2.0
2 parents 4c8c11b + 5f4e740 commit d0140c8

File tree

2 files changed

+87
-17
lines changed

2 files changed

+87
-17
lines changed

.github/release-checklist.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,8 @@ PR for tracking changes for the x.x.x release. Target release date: **DOW MONTH
4747
- [ ] Make sure all CI builds are green.
4848
- [ ] Tag and create a release against `main` (careful, GH defaults to `develop`!) & copy & paste the changelog to it.
4949
:pencil2: Check if anything from the link collection at the bottom of the changelog needs to be copied in!
50+
- Remove square brackets from all ticket links or make them proper full links (as GH markdown parser doesn't parse these correctly).
51+
- Change all contributor links to full inline links (as GH markdown parser on the Releases page doesn't parse these correctly).
5052
- [ ] Make sure all CI builds are green.
5153
- [ ] Close the milestone.
5254
- [ ] Open a new milestone for the next release.

CHANGELOG.md

Lines changed: 85 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,67 @@ This projects adheres to [Semantic Versioning](https://semver.org/) and [Keep a
88

99
_No documentation available about unreleased changes as of yet._
1010

11+
## [3.2.0] - 2025-07-24
12+
13+
### Added
14+
- New `WordPress.WP.GetMetaSingle` sniff to the `WordPress-Extra` ruleset. Props [@rodrigoprimo]! [#2465]
15+
This sniff warns when `get_*_meta()` and `get_metadata*()` functions are used with the `$meta_key`/`$key` param, but without the `$single` parameter as this could lead to unexpected behavior due to the different return types.
16+
- `WordPress-Extra`: the following additional sniffs have been added to the ruleset: `Generic.Strings.UnnecessaryHeredoc` and `Generic.WhiteSpace.HereNowdocIdentifierSpacing`. [#2534]
17+
- The `rest_sanitize_boolean()` functions to the list of known "sanitizing" functions. Props [@westonruter]. [#2530]
18+
- End-user documentation to the following existing sniffs: `WordPress.DB.PreparedSQL` (props [@jaymcp], [#2454]), `WordPress.NamingConventions.ValidFunctionName` (props [@richardkorthuis] and [@rodrigoprimo], [#2452], [#2531]), `WordPress.NamingConventions.ValidVariableName` (props [@richardkorthuis], [#2457]).
19+
This documentation can be exposed via the [`PHP_CodeSniffer` `--generator=...` command-line argument](https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki/Usage).
20+
21+
### Changed
22+
- The minimum required `PHP_CodeSniffer` version to 3.13.0 (was 3.9.0). [#2532]
23+
- The minimum required `PHPCSUtils` version to 1.1.0 (was 1.0.10). [#2532]
24+
- The minimum required `PHPCSExtra` version to 1.4.0 (was 1.2.1). [#2532]
25+
- Sniffs based on the `AbstractFunctionParameterSniff` will now call a dedicated `process_first_class_callable()` method for PHP 8.1+ first class callables. Props [@rodrigoprimo], [@jrfnl]. [#2518], [#2544]
26+
By default, the method won't do anything, but individual sniffs extending the `AbstractFunctionParameterSniff` class can choose to implement the method to handle first class callables.
27+
Previously, first class callables were treated as a function call without parameters and would trigger the `process_no_parameters()` method.
28+
- The minimum required prefix length for the `WordPress.NamingConventions.PrefixAllGlobals` sniff has been changed from 3 to 4 characters. Props [@davidperezgar]. [#2479]
29+
- The default value for `minimum_wp_version`, as used by a [number of sniffs detecting usage of deprecated WP features](https://github.com/WordPress/WordPress-Coding-Standards/wiki/Customizable-sniff-properties#various-sniffs-set-the-minimum-supported-wp-version), has been updated to `6.5`. [#2553]
30+
- `WordPress.NamingConventions.ValidVariableName` now allows for PHP 8.4 properties in interfaces. [#2532]
31+
- `WordPress.NamingConventions.PrefixAllGlobals` has been updated to recognize pluggable functions introduced in WP up to WP 6.8.1. [#2537]
32+
- `WordPress.WP.Capabilities` has been updated to recognize new capabilities introduced in WP up to WP 6.8.1. [#2537]
33+
- `WordPress.WP.ClassNameCase` has been updated to recognize classes introduced in WP up to WP 6.8.1. [#2537]
34+
- `WordPress.WP.DeprecatedFunctions` now detects functions deprecated in WordPress up to WP 6.8.1. [#2537]
35+
- `WordPress.WP.DeprecatedParameters` now detects parameters deprecated in WordPress up to WP 6.8.1. [#2537]
36+
- `WordPress.WP.DeprecatedParameterValues` now detects parameter values deprecated in WordPress up to WP 6.8.1. [#2537]
37+
- Minor performance improvements.
38+
- Developer happiness: prevent creating a `composer.lock` file. Thanks [@fredden]! [#2443]
39+
- Various housekeeping, including documentation and test improvements. Includes contributions by [@rodrigoprimo] and [@szepeviktor].
40+
- All sniffs are now also being tested against PHP 8.4 for consistent sniff results. [#2511]
41+
42+
### Deprecated
43+
44+
### Removed
45+
46+
- The `Generic.Functions.CallTimePassByReference` has been removed from the `WordPress-Extra` ruleset. Props [@rodrigoprimo]. [#2536]
47+
This sniff was dated anyway and deprecated in PHP_CodeSniffer. If you need to check if your code is PHP cross-version compatible, use the [PHPCompatibility] standard instead.
48+
49+
### Fixed
50+
- Sniffs based on the `AbstractClassRestrictionsSniff` could previously run into a PHPCS `Internal.Exception`, leading to fixes not being made. [#2500]
51+
- Sniffs based on the `AbstractFunctionParameterSniff` will now bow out more often when it is sure the code under scan is not calling the target function and during live coding, preventing false positives. Props [@rodrigoprimo]. [#2518]
52+
53+
[#2443]: https://github.com/WordPress/WordPress-Coding-Standards/pull/2443
54+
[#2465]: https://github.com/WordPress/WordPress-Coding-Standards/pull/2465
55+
[#2452]: https://github.com/WordPress/WordPress-Coding-Standards/pull/2452
56+
[#2454]: https://github.com/WordPress/WordPress-Coding-Standards/pull/2454
57+
[#2457]: https://github.com/WordPress/WordPress-Coding-Standards/pull/2457
58+
[#2479]: https://github.com/WordPress/WordPress-Coding-Standards/pull/2479
59+
[#2500]: https://github.com/WordPress/WordPress-Coding-Standards/pull/2500
60+
[#2511]: https://github.com/WordPress/WordPress-Coding-Standards/pull/2511
61+
[#2518]: https://github.com/WordPress/WordPress-Coding-Standards/pull/2518
62+
[#2530]: https://github.com/WordPress/WordPress-Coding-Standards/pull/2530
63+
[#2531]: https://github.com/WordPress/WordPress-Coding-Standards/pull/2531
64+
[#2532]: https://github.com/WordPress/WordPress-Coding-Standards/pull/2532
65+
[#2534]: https://github.com/WordPress/WordPress-Coding-Standards/pull/2534
66+
[#2536]: https://github.com/WordPress/WordPress-Coding-Standards/pull/2536
67+
[#2537]: https://github.com/WordPress/WordPress-Coding-Standards/pull/2537
68+
[#2544]: https://github.com/WordPress/WordPress-Coding-Standards/pull/2544
69+
[#2553]: https://github.com/WordPress/WordPress-Coding-Standards/pull/2553
70+
71+
1172
## [3.1.0] - 2024-03-25
1273

1374
### Added
@@ -1602,8 +1663,10 @@ Initial tagged release.
16021663

16031664
[Composer PHPCS plugin]: https://github.com/PHPCSStandards/composer-installer
16041665
[PHP_CodeSniffer]: https://github.com/PHPCSStandards/PHP_CodeSniffer
1666+
[PHPCompatibility]: https://github.com/PHPCompatibility/PHPCompatibility
16051667

16061668
[Unreleased]: https://github.com/WordPress/WordPress-Coding-Standards/compare/main...HEAD
1669+
[3.2.0]: https://github.com/WordPress/WordPress-Coding-Standards/compare/3.1.0...3.2.0
16071670
[3.1.0]: https://github.com/WordPress/WordPress-Coding-Standards/compare/3.0.1...3.1.0
16081671
[3.0.1]: https://github.com/WordPress/WordPress-Coding-Standards/compare/3.0.0...3.0.1
16091672
[3.0.0]: https://github.com/WordPress/WordPress-Coding-Standards/compare/2.3.0...3.0.0
@@ -1635,20 +1698,25 @@ Initial tagged release.
16351698
[0.3.0]: https://github.com/WordPress/WordPress-Coding-Standards/compare/2013-10-06...0.3.0
16361699
[2013-10-06]: https://github.com/WordPress/WordPress-Coding-Standards/compare/2013-06-11...2013-10-06
16371700

1638-
[@anomiex]: https://github.com/anomiex
1639-
[@Chouby]: https://github.com/Chouby
1640-
[@ckanitz]: https://github.com/ckanitz
1641-
[@craigfrancis]: https://github.com/craigfrancis
1642-
[@dawidurbanski]: https://github.com/dawidurbanski
1643-
[@desrosj]: https://github.com/desrosj
1644-
[@grappler]: https://github.com/grappler
1645-
[@Ipstenu]: https://github.com/Ipstenu
1646-
[@JDGrimes]: https://github.com/JDGrimes
1647-
[@khacoder]: https://github.com/khacoder
1648-
[@Luc45]: https://github.com/Luc45
1649-
[@marconmartins]: https://github.com/marconmartins
1650-
[@NielsdeBlaauw]: https://github.com/NielsdeBlaauw
1651-
[@rodrigoprimo]: https://github.com/rodrigoprimo
1652-
[@slaFFik]: https://github.com/slaFFik
1653-
[@sandeshjangam]: https://github.com/sandeshjangam
1654-
[@westonruter]: https://github.com/westonruter
1701+
[@anomiex]: https://github.com/anomiex
1702+
[@Chouby]: https://github.com/Chouby
1703+
[@ckanitz]: https://github.com/ckanitz
1704+
[@craigfrancis]: https://github.com/craigfrancis
1705+
[@davidperezgar]: https://github.com/davidperezgar
1706+
[@dawidurbanski]: https://github.com/dawidurbanski
1707+
[@desrosj]: https://github.com/desrosj
1708+
[@fredden]: https://github.com/fredden
1709+
[@grappler]: https://github.com/grappler
1710+
[@Ipstenu]: https://github.com/Ipstenu
1711+
[@jaymcp]: https://github.com/jaymcp
1712+
[@JDGrimes]: https://github.com/JDGrimes
1713+
[@khacoder]: https://github.com/khacoder
1714+
[@Luc45]: https://github.com/Luc45
1715+
[@marconmartins]: https://github.com/marconmartins
1716+
[@NielsdeBlaauw]: https://github.com/NielsdeBlaauw
1717+
[@richardkorthuis]: https://github.com/richardkorthuis
1718+
[@rodrigoprimo]: https://github.com/rodrigoprimo
1719+
[@slaFFik]: https://github.com/slaFFik
1720+
[@sandeshjangam]: https://github.com/sandeshjangam
1721+
[@szepeviktor]: https://github.com/szepeviktor
1722+
[@westonruter]: https://github.com/westonruter

0 commit comments

Comments
 (0)