Changeset 46090

Timestamp:

09/11/2019 01:50:23 AM (4 years ago)

Author:

SergeyBiryukov

Message:

Accessibility: Comments: In comment_form(), remove aria-describedby attribute from the email field if there's no associated description in the comment_notes_before argument.

The attribute is meant to communicate to user agents and assistive technologies that the element has a description. If the referenced description is missing, it will be flagged as failure by any automated accessibility checker tool and, most importantly, is potentially confusing for assistive technologies users.

Props afercia, joedolson, dinhtungdu, donmhico, SergeyBiryukov.
Fixes #47975.

Location:

trunk

Files:

• src/wp-includes/comment-template.php (modified) (2 diffs)
• tests/phpunit/tests/comment/commentForm.php (modified) (5 diffs)

trunk/src/wp-includes/comment-template.php

@@ -2429 +2429 @@
     $args = array_merge( $defaults, $args );
 
+    // Remove aria-describedby from the email field if there's no associated description.
+    if ( false === strpos( $args['comment_notes_before'], 'id="email-notes"' ) ) {
+        $args['fields']['email'] = str_replace(
+            ' aria-describedby="email-notes"',
+            '',
+            $args['fields']['email']
+        );
+    }
+
     /**
      * Fires before the comment form.
@@ -2510 +2519 @@
             endif;
 
-            // Prepare an array of all fields, including the textarea
+            // Prepare an array of all fields, including the textarea.
             $comment_fields = array( 'comment' => $args['comment_field'] ) + (array) $args['fields'];
 

trunk/tests/phpunit/tests/comment/commentForm.php

@@ -14 +14 @@
             'label_submit' => 'foo-label',
         );
+
         $form = get_echo( 'comment_form', array( $args, $p ) );
 
@@ -31 +32 @@
             'submit_button' => '<input name="custom-%1$s" type="submit" id="custom-%2$s" class="custom-%3$s" value="custom-%4$s" />',
         );
+
         $form = get_echo( 'comment_form', array( $args, $p ) );
 
@@ -47 +49 @@
             'submit_field' => '<p class="my-custom-submit-field">%1$s %2$s</p>',
         );
+
         $form = get_echo( 'comment_form', array( $args, $p ) );
 
@@ -95 +98 @@
             ),
         );
+
         $form = get_echo( 'comment_form', array( $args, $p ) );
 
@@ -101 +105 @@
         $this->assertRegExp( '|<p class="comment\-form\-cookies\-consent">.*?</p>|', $form );
     }
+
+    /**
+     * @ticket 47975
+     */
+    public function test_aria_describedby_email_notes_should_not_be_added_if_no_email_notes() {
+        $p = self::factory()->post->create();
+
+        $form_with_aria = get_echo( 'comment_form', array( array(), $p ) );
+
+        $this->assertContains( 'aria-describedby="email-notes"', $form_with_aria );
+
+        $args = array(
+            'comment_notes_before' => '',
+        );
+
+        $form_without_aria = get_echo( 'comment_form', array( $args, $p ) );
+
+        $this->assertNotContains( 'aria-describedby="email-notes"', $form_without_aria );
+    }
 }