WordPress Coding Standards 3.4.0 is Here: Preparing for WP 7.0 and New CLI Features
WordPressCS 3.4.0 introduces a new co-maintainer, improves end-user documentation for numerous sniffs, and updates PHP_CodeSniffer requirements.
WordPressCS 3.4.0 focuses on improved documentation and refined array declaration rules for PHP developers.
- WordPressCS 3.4.0 welcomes Rodrigo Primo as a new project co-maintainer.
- New end-user documentation added for 14 code sniffs, including database and security rules.
- Minimum PHP_CodeSniffer requirement raised to 3.13.5.
- Array declaration property renamed to better reflect explicit key handling.
Leadership and Community Maintenance
The release of WordPress Coding Standards (WordPressCS) 3.4.0 marks a transition in the project's stewardship. The project has officially welcomed Rodrigo Primo (@rodrigoprimo) as a co-maintainer. Community-driven maintenance is a cornerstone of the WordPress ecosystem, and adding dedicated maintainers helps ensure the longevity and consistency of the rules used to govern PHP code quality across thousands of plugins and themes.
WordPressCS is a collection of PHP_CodeSniffer rules (sniffs) that validate code against the official WordPress development best practices. By automating these checks, developers can identify security vulnerabilities, performance bottlenecks, and formatting inconsistencies before code is deployed.
Updated Array Declaration Standards
A specific focus of this release involves the refinement of how arrays are handled within the standards. The WordPress.Arrays.ArrayDeclarationSpacing sniff has introduced a new property: allow_single_item_single_line_explicit_key_arrays. This property is designed to replace the now-deprecated allow_single_item_single_line_associative_arrays property.
The terminology shift from "associative" to "explicit key" provides greater technical accuracy. In PHP, an array can have keys explicitly defined even if they are integers, whereas "associative" often implies string keys in casual conversation. This update allows developers to permit single-item arrays on a single line when keys are explicitly provided, offering more granular control over code style preferences without triggering unnecessary warnings.
Expansion of End-User Documentation
One of the most significant additions in version 3.4.0 is the inclusion of comprehensive end-user documentation for a wide range of existing sniffs. This documentation is intended to help developers understand the rationale behind specific rules and how to fix violations. The following areas received documentation updates:
- Database Operations: Sniffs related to
DirectDatabaseQuery,RestrictedClasses, andSlowDBQuerynow feature detailed explanations. These rules are critical for maintaining site performance and preventing SQL injection. - PHP Functions: Documentation was added for
DevelopmentFunctions,RestrictedPHPFunctions, andPregQuoteDelimiter. These guides help steer developers away from dangerous functions likeeval()or debugging tools that should not reach production. - Security and Global Scope: Rules such as
PluginMenuSlugandGlobalVariablesOverridenow have better descriptive support. Overriding global variables in WordPress can lead to unpredictable behavior and conflicts with other plugins. - Code Analysis: The
AssignmentInTernaryConditionsniff now includes documentation to discourage complex logic that reduces code readability.
These documents can be generated and viewed locally by developers using the PHP_CodeSniffer --generator=... command-line argument, making the standards a more effective teaching tool for junior developers and contributors.
Requirement and Dependency Shifts
To maintain compatibility with the latest improvements in the underlying static analysis engine, WordPressCS 3.4.0 has increased its minimum version requirements. The project now requires PHP_CodeSniffer version 3.13.5 or higher (previously 3.13.4). Additionally, the minimum required version of PHPCSUtils, a suite of utility functions for sniffs, has been raised to 1.2.2 from 1.1.0.
Bumping these dependencies ensures that the WordPress sniffs can leverage the latest bug fixes and performance optimizations provided by the core PHPCS project. It also ensures that the sniffs remain compatible with newer versions of PHP, which often introduce new syntax that requires updated parsing logic.
Impact on Development Workflows
For developers using Composer to manage their WordPress environments, updating to 3.4.0 should be straightforward, provided their environment meets the new PHP_CodeSniffer version requirements. Projects that were previously utilizing the allow_single_item_single_line_associative_arrays property in their phpcs.xml.dist files should begin transitioning to the new allow_single_item_single_line_explicit_key_arrays property to avoid deprecation notices in future versions.
The collaborative effort behind this release is evident in the contributor list, with individuals such as Rafael Funchal, Matt Galdino, Paul Gibbs, and several others contributing to the documentation and technical improvements. This release reinforces the community's commitment to making the WordPress codebase more robust, secure, and easier to maintain through standardized automated linting.
Enjoyed this?
Get more posts like this delivered to your inbox.
