>>> [!note] Migrated issue <!-- Drupal.org comment --> <!-- Migrated from issue #3039007. --> Reported by: [gapple](https://www.drupal.org/user/490940) >>> <h3 id="summary-problem-motivation">Problem/Motivation</h3> <p>State what you believe is wrong or missing from the current standards.</p> <h3 id="summary-benefits">Benefits</h3> <p>If we adopted this change, the Drupal Project would benefit by ...</p> <h3 id="summary-supporters">Three supporters required</h3> <ol> <li><a href="https://www.drupal.org/u/">https://www.drupal.org/u/</a>{userid} (date that user added support)</li> <li><a href="https://www.drupal.org/u/">https://www.drupal.org/u/</a>{userid} (date that user added support)</li> <li><a href="https://www.drupal.org/u/">https://www.drupal.org/u/</a>{userid} (date that user added support)</li> </ol> <h3 id="summary-proposed-changes">Proposed changes</h3> <p>Provide all proposed changes to the Drupal <a href="https://www.drupal.org/docs/develop/standards">Coding standards</a>. Give a link to each section that will be changed, and show the current text and proposed text as in the following layout:</p> <h4>1. {link to the documentation heading that is to change}</h4> <h5>Current text</h5> <blockquote><p>Add current text in blockquotes</p></blockquote> <h5>Proposed text</h5> <blockquote><p>Add proposed text in blockquotes</p></blockquote> <h4>2. Repeat the above for each page or sub-page that needs to be changed.</h4> <h3 id="summary-remaining-tasks">Remaining tasks</h3> <ol> <li><del>Create this issue in the Coding Standards queue, using the defined template</del></li> <li>Add supporters</li> <li>Create a Change Record</li> <li>Review by the Coding Standards Committee</li> <li>Coding Standards Committee takes action as required</li> <li>Tagged with 'Needs documentation edits' if Core is not affected</li> <li>Discussed by the Core Committer Committee, if it impacts Drupal Core</li> <li>Documentation updates <ol> <li>Edit all pages</li> <li>Publish change record</li> <li>Remove 'Needs documentation edits' tag</li> </ol> </li> <li>If applicable, create follow-up issues for PHPCS rules/sniffs changes</li> </ol> <p>For a fuller explanation of these steps see the <a href="https://www.drupal.org/project/coding_standards" title="Coding Standards project page">Coding Standards project page</a></p> <p>==== Original template to be converted to the new template above and then removed ===</p> <h3 id="summary-problem-motivation">Problem/Motivation</h3> <p><a href="https://www.drupal.org/docs/develop/standards/coding-standards#array">Per the current standard</a>:</p> <blockquote><p>Note that if the line declaring an array spans longer than 80 characters (often the case with form and menu declarations), each element should be broken into its own line, and indented one level:</p></blockquote> <p>Coder currently also has an exception for arrays of only two items - only arrays with three or more items receive a warning for being over 80 characters.</p> <p>However, this is impractical in certain circumstances:</p> <p>1. In a complex form, I'm altering <code>#parents</code> to remove wrapping elements from the structure of submitted values in form state. The array goes over 80 characters on the line, but breaking it into individual lines is awkward for this type of simple definition</p> <pre>class {<br>&nbsp; function () {<br>&nbsp;&nbsp;&nbsp; foreach(...) {<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; foreach (...) {<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; $form[$policyTypeKey]['directives'][$directiveName]['options']['flags_wrapper']['flags'] = [<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; '#type' =&gt; 'checkboxes',<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; '#parents' =&gt; [$policyTypeKey, 'directives', $directiveName, 'flags'],<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; '#options' =&gt; [<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 'unsafe-inline' =&gt; "'unsafe-inline'",<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 'unsafe-eval' =&gt; "'unsafe-eval'",<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 'unsafe-hashes' =&gt; "'unsafe-hashes'",<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 'unsafe-allow-redirects' =&gt; "'unsafe-allow-redirects'",<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 'strict-dynamic' =&gt; "'strict-dynamic'",<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 'report-sample' =&gt; "'report-sample'",<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ],<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; '#default_value' =&gt; $config-&gt;get($policyTypeKey . '.directives.' . $directiveName . '.flags') ?: [],<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ];<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; }<br>&nbsp;&nbsp;&nbsp; }<br>&nbsp; }<br>}</pre><p>2. Later when retrieving the form values during validation or submission, they are accessed by specifying the keys in an array which will also be longer than 80 characters.</p> <pre>class {<br>&nbsp; function () {<br>&nbsp;&nbsp;&nbsp; foreach (...) {<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; $reportHandlerOptions = $form_state-&gt;getValue([$policyTypeKey, 'reporting', $reportHandlerPluginId]);<br>&nbsp;&nbsp;&nbsp; }<br>&nbsp; }<br>}</pre><h3 id="summary-proposed-resolution">Proposed resolution</h3> <p>Update the note in the standard to:</p> <blockquote><p> Note that if the line declaring an associative array contains three or more elements and spans longer than 80 characters (often the case with form and menu declarations), each element should be broken into its own line, and indented one level </p></blockquote> <p>e.g.<br> This would not produce a warning:<br> <code><br> $variable = ['a', 'really', 'long', 'array', 'that', 'is', 'longer', 'than', 80, 'characters];<br> <code></code></code></p> > Related issue: [Issue #1805542](https://www.drupal.org/node/1805542)