Ticket #20302: 20302.2.diff

src/wp-includes/comment-template.php

@@ -1242 +1242 @@
  * @global int        $user_ID
  * @global string     $user_identity
  * @global bool       $overridden_cpage
- * @global bool       $withcomments 
+ * @global bool       $withcomments
  *
  * @param string $file              Optional. The file to load. Default '/comments.php'.
  * @param bool   $separate_comments Optional. Whether to separate the comments by comment type.
@@ -2026 +2026 @@
  *                                        fields. Default: '<p class="form-submit">%1$s %2$s</a>', where %1$s is the
  *                                        submit button markup and %2$s is the comment hidden fields.
  *     @type string $format               The comment form format. Default 'xhtml'. Accepts 'xhtml', 'html5'.
+ *     @type array  $attributes_form      Additional attributes to apply to
  * }
  * @param int|WP_Post $post_id Post ID or WP_Post object to generate the form for. Default current post.
  */
@@ -2089 +2090 @@
                 'submit_button'        => '<input name="%1$s" type="submit" id="%2$s" class="%3$s" value="%4$s" />',
                 'submit_field'         => '<p class="form-submit">%1$s %2$s</p>',
                 'format'               => 'xhtml',
+                'attributes_form'      => array(),
         );
 
         /**
@@ -2105 +2107 @@
         // Ensure that the filtered args contain all required default values.
         $args = array_merge( $defaults, $args );
 
+        // Build the <form> attributes.
+        $attributes = array(
+                'action'     => site_url( '/wp-comments-post.php' ),
+                'method'     => 'post',
+                'id'         => $args['id_form'],
+                'class'      => $args['class_form'],
+                'novalidate' => $html5,
+        );
+
+        if ( is_array( $args['attributes_form'] ) ) {
+                $attributes = array_merge( $attributes, $args['attributes_form'] );
+        }
+
         if ( comments_open( $post_id ) ) : ?>
                 <?php
                 /**
@@ -2137 +2152 @@
                                  */
                                 do_action( 'comment_form_must_log_in_after' );
                         else : ?>
-                                <form action="<?php echo site_url( '/wp-comments-post.php' ); ?>" method="post" id="<?php echo esc_attr( $args['id_form'] ); ?>" class="<?php echo esc_attr( $args['class_form'] ); ?>"<?php echo $html5 ? ' novalidate' : ''; ?>>
+                                <?php
+                                        echo '<form';
+
+                                        // Build the form attributes.
+                                        foreach ( $attributes as $attr_name => $attr_val ) {
+                                                if ( true === $attr_val ) {
+                                                        echo ' ' . esc_attr( $attr_name );
+                                                } else {
+                                                        printf( ' %s="%s"', esc_attr( $attr_name ), esc_attr( $attr_val ) );
+                                                }
+                                        }
+
+                                        echo '>';
+                                ?>
                                         <?php
                                         /**
                                          * Fires at the top of the comment form, inside the form tag.

tests/phpunit/tests/comment/commentsTemplate.php

@@ -685 +685 @@
                 $this->assertSame( array( $comment_4, $comment_3 ), $found_cids );
         }
 
+        /**
+         * Validate that the current attributes (action, method, id, class, and novalidate) are
+         * still present after moving to an array-based build.
+         *
+         * @ticket 20302
+         */
+        public function test_building_comment_form_attributes_from_array() {
+                $p = self::factory()->post->create();
+
+                add_filter( 'wp_get_current_commenter', array( $this, 'fake_current_commenter' ) );
+                $this->go_to( get_permalink( $p ) );
+                $template = get_echo( 'comments_template' );
+                remove_filter( 'wp_get_current_commenter', array( $this, 'fake_current_commenter' ) );
+
+                $this->assertEquals( 1, preg_match( '|\saction="(.+)/wp-comments-post.php"|i', $template ) );
+                $this->assertContains( 'method="post"', $template );
+                $this->assertContains( 'id="commentform"', $template );
+                $this->assertContains( 'class="comment-form"', $template );
+        }
+
+        /**
+         * @ticket 20302
+         */
+        public function test_extra_comment_form_attributes() {
+                $p = self::factory()->post->create();
+
+                /**
+                 * Anonymous function to alter the 'attributes' value for the 'comment_form_defaults' filter.
+                 */
+                add_filter( 'comment_form_defaults', array( $this, 'extra_comment_form_attributes_cb' ) );
+
+                add_filter( 'wp_get_current_commenter', array( $this, 'fake_current_commenter' ) );
+                $this->go_to( get_permalink( $p ) );
+                $template = get_echo( 'comments_template' );
+                remove_filter( 'wp_get_current_commenter', array( $this, 'fake_current_commenter' ) );
+
+                // Validate that default attributes aren't overwritten.
+                $this->assertContains( 'method="post"', $template );
+                $this->assertContains( 'id="commentform"', $template );
+                $this->assertContains( 'class="comment-form"', $template );
+
+                // Validate our custom attribute.
+                $this->assertContains( 'data-test-attribute="hooray!"', $template );
+                $this->assertContains( 'onclick="dosomething()"', $template );
+        }
+
+        /**
+         * Callback for test_extra_comment_form_attributes().
+         *
+         * @ticket 20302
+         */
+        public function extra_comment_form_attributes_cb( $defaults ) {
+                $defaults['attributes_form'] = array(
+                        'data-test-attribute' => 'hooray!',
+                        'onclick'             => 'dosomething()',
+                );
+
+                return $defaults;
+        }
+
         public function fake_current_commenter( $commenter ) {
                 $commenter['comment_author_email'] = 'foo@example.com';
                 return $commenter;
         }
+
 }