Skip to content

Arrays/ArrayDeclarationSpacing: add new property and soft-deprecate old one #2696

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
GaryJones merged 2 commits into from
Feb 24, 2026
Merged

Arrays/ArrayDeclarationSpacing: add new property and soft-deprecate old one #2696

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
03a96ee
Arrays/ArrayDeclarationSpacing: move parse error test to its own file
rodrigoprimo Feb 6, 2026
2229662
Arrays/ArrayDeclarationSpacing: add new property and soft-deprecate o…
rodrigoprimo Feb 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 24 additions & 3 deletions WordPress/Sniffs/Arrays/ArrayDeclarationSpacingSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,25 @@
* `allow_single_item_single_line_associative_arrays` property.
* @since 3.0.0 Removed various whitespace related checks and fixers in favor of the PHPCSExtra
* `NormalizedArrays.Arrays.ArrayBraceSpacing` sniff.
* @since 3.4.0 The `allow_single_item_single_line_associative_arrays` property has been
* deprecated in favor of the new `allow_single_item_single_line_explicit_key_arrays` property.
*/
final class ArrayDeclarationSpacingSniff extends Sniff {

/**
* Whether to allow single item arrays with explicit keys to be single line.
*
* @since 3.4.0
*
* @var bool Defaults to true.
*/
public $allow_single_item_single_line_explicit_key_arrays = true;
Copy link
Copy Markdown
Member

@jrfnl jrfnl Feb 23, 2026

Choose a reason for hiding this comment

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

I'm trying to think of a shorter name which is still descriptive enough and failing.

@GaryJones @dingo-d Have either of you got any suggestions ?

If not, I'm okay with leaving it at what it currently is. Just feels clunky and if we do want to change the name, now would be the time.

Copy link
Copy Markdown
Member

@GaryJones GaryJones Feb 24, 2026

Choose a reason for hiding this comment

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

Let's leave it as is. There are alternatives, but I'm not convinced by any of them for various reasons.


/**
* Whether or not to allow single item arrays with explicit keys to be single line.
*
* @since 0.14.0
* @deprecated 3.4.0 Use $allow_single_item_single_line_explicit_key_arrays instead.
*
* @var bool Defaults to true.
*/
Expand Down Expand Up @@ -114,10 +126,19 @@ public function process_token( $stackPtr ) {
* @return void
*/
protected function process_single_line_array( $stackPtr, $opener, $closer ) {
// For now, if the new property has not been changed from its default value and the deprecated property has, use
// the deprecated property's value.
$allow_single_item = $this->allow_single_item_single_line_explicit_key_arrays;
if ( true === $allow_single_item
&& false === $this->allow_single_item_single_line_associative_arrays
) {
$allow_single_item = false;
}

$array_items = PassedParameters::getParameters( $this->phpcsFile, $stackPtr );
if ( ( false === $this->allow_single_item_single_line_associative_arrays
if ( ( false === $allow_single_item
&& empty( $array_items ) )
|| ( true === $this->allow_single_item_single_line_associative_arrays
|| ( true === $allow_single_item
&& \count( $array_items ) === 1 )
) {
return;
Expand All @@ -138,7 +159,7 @@ protected function process_single_line_array( $stackPtr, $opener, $closer ) {
return;
}
$error = 'When an array is declared with explicit keys, each value should start on %s.';
if ( true === $this->allow_single_item_single_line_associative_arrays ) {
if ( true === $allow_single_item ) {
$error = 'When a multi-item array is declared with explicit keys, each value should start on %s.';
}

Expand Down
15 changes: 12 additions & 3 deletions WordPress/Tests/Arrays/ArrayDeclarationSpacingUnitTest.1.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,15 @@ $bad = array(
// Don't confuse list arrows with array arrows.
$okay = array( $item1, list( 'key1' => $a, 'key2' => $b ) = $array, $item3 );

// Live coding/parse error.
// This must be the last test in the file!
$ignore = array( $item1, 'key' => 'value',
// phpcs:set WordPress.Arrays.ArrayDeclarationSpacing allow_single_item_single_line_explicit_key_arrays false

$bad = array( 'key' => 'value' ); // Bad.
$bad = array( 'key1' => 'value1', 'key2' => 'value2' ); // Bad.

// phpcs:set WordPress.Arrays.ArrayDeclarationSpacing allow_single_item_single_line_explicit_key_arrays true
Comment thread
jrfnl marked this conversation as resolved.

// phpcs:set WordPress.Arrays.ArrayDeclarationSpacing allow_single_item_single_line_associative_arrays null

$ok = array( 'key' => 'value' ); // OK, invalid value for deprecated property should be ignored.

// phpcs:set WordPress.Arrays.ArrayDeclarationSpacing allow_single_item_single_line_associative_arrays true
20 changes: 17 additions & 3 deletions WordPress/Tests/Arrays/ArrayDeclarationSpacingUnitTest.1.inc.fixed
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,20 @@ $bad = array(
// Don't confuse list arrows with array arrows.
$okay = array( $item1, list( 'key1' => $a, 'key2' => $b ) = $array, $item3 );

// Live coding/parse error.
// This must be the last test in the file!
$ignore = array( $item1, 'key' => 'value',
// phpcs:set WordPress.Arrays.ArrayDeclarationSpacing allow_single_item_single_line_explicit_key_arrays false

$bad = array(
'key' => 'value'
); // Bad.
$bad = array(
'key1' => 'value1',
'key2' => 'value2'
); // Bad.

// phpcs:set WordPress.Arrays.ArrayDeclarationSpacing allow_single_item_single_line_explicit_key_arrays true

// phpcs:set WordPress.Arrays.ArrayDeclarationSpacing allow_single_item_single_line_associative_arrays null

$ok = array( 'key' => 'value' ); // OK, invalid value for deprecated property should be ignored.

// phpcs:set WordPress.Arrays.ArrayDeclarationSpacing allow_single_item_single_line_associative_arrays true
7 changes: 7 additions & 0 deletions WordPress/Tests/Arrays/ArrayDeclarationSpacingUnitTest.2.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,3 +107,10 @@ $bad = [

// Don't confuse list arrows with array arrows.
$okay = [ $item1, [ 'key1' => $a, 'key2' => $b ] = $array, $item3 ];

// phpcs:set WordPress.Arrays.ArrayDeclarationSpacing allow_single_item_single_line_explicit_key_arrays false

$bad = [ 'key' => 'value' ]; // Bad.
$bad = [ 'key1' => 'value1', 'key2' => 'value2' ]; // Bad.

// phpcs:set WordPress.Arrays.ArrayDeclarationSpacing allow_single_item_single_line_explicit_key_arrays true
12 changes: 12 additions & 0 deletions WordPress/Tests/Arrays/ArrayDeclarationSpacingUnitTest.2.inc.fixed
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,3 +163,15 @@ $bad = [

// Don't confuse list arrows with array arrows.
$okay = [ $item1, [ 'key1' => $a, 'key2' => $b ] = $array, $item3 ];

// phpcs:set WordPress.Arrays.ArrayDeclarationSpacing allow_single_item_single_line_explicit_key_arrays false

$bad = [
'key' => 'value'
]; // Bad.
$bad = [
'key1' => 'value1',
'key2' => 'value2'
]; // Bad.

// phpcs:set WordPress.Arrays.ArrayDeclarationSpacing allow_single_item_single_line_explicit_key_arrays true
8 changes: 8 additions & 0 deletions WordPress/Tests/Arrays/ArrayDeclarationSpacingUnitTest.3.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<?php

/*
* Intentional parse error (unclosed array).
* This should be the only test in this file.
*/

$ignore = array( $item1, 'key' => 'value',
40 changes: 22 additions & 18 deletions WordPress/Tests/Arrays/ArrayDeclarationSpacingUnitTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,29 +51,33 @@ public function getErrorList( $testFile = '' ) {
62 => 1,
63 => 1,
75 => 1,
87 => 1,
88 => 1,
);

// Short arrays.
case 'ArrayDeclarationSpacingUnitTest.2.inc':
return array(
9 => 4,
13 => 2,
15 => 1,
19 => 1,
22 => 1,
25 => 1,
44 => 1,
45 => 1,
48 => 1,
49 => 1,
52 => 2,
54 => 1,
57 => 1,
58 => 1,
62 => 1,
63 => 1,
75 => 1,
97 => 1,
9 => 4,
13 => 2,
15 => 1,
19 => 1,
22 => 1,
25 => 1,
44 => 1,
45 => 1,
48 => 1,
49 => 1,
52 => 2,
54 => 1,
57 => 1,
58 => 1,
62 => 1,
63 => 1,
75 => 1,
97 => 1,
113 => 1,
114 => 1,
);

default:
Expand Down
Loading