trailing_comma_in_multiline.rst

Rule trailing_comma_in_multiline

Multi-line arrays, arguments list and parameters list must have a trailing comma.

Configuration

after_heredoc

Whether a trailing comma should also be placed after heredoc end.

Allowed types: bool

Default value: false

elements

Where to fix multiline trailing comma (PHP >= 7.3 required for arguments, PHP >= 8.0 for parameters).

Allowed values: a subset of ['arrays', 'arguments', 'parameters']

Default value: ['arrays']

Examples

Example #1

Default configuration.

--- Original
+++ New
 <?php
 array(
     1,
-    2
+    2,
 );

Example #2

With configuration: ['after_heredoc' => true].

--- Original
+++ New
 <?php
     $x = [
         'foo',
         <<<EOD
             bar
-            EOD
+            EOD,
     ];

Example #3

With configuration: ['elements' => ['arguments']].

--- Original
+++ New
 <?php
 foo(
     1,
-    2
+    2,
 );

Example #4

With configuration: ['elements' => ['parameters']].

--- Original
+++ New
 <?php
 function foo(
     $x,
-    $y
+    $y,
 )
 {
 }

Rule sets

The rule is part of the following rule sets:

@PHP73Migration

Using the @PHP73Migration rule set will enable the trailing_comma_in_multiline rule with the config below:

['after_heredoc' => true]

@PHP74Migration

Using the @PHP74Migration rule set will enable the trailing_comma_in_multiline rule with the config below:

['after_heredoc' => true]

@PHP80Migration

Using the @PHP80Migration rule set will enable the trailing_comma_in_multiline rule with the config below:

['after_heredoc' => true]

@PhpCsFixer

Using the @PhpCsFixer rule set will enable the trailing_comma_in_multiline rule with the default config.

@Symfony

Using the @Symfony rule set will enable the trailing_comma_in_multiline rule with the default config.