Changeset 31699

Timestamp:

03/10/2015 07:07:31 PM (10 years ago)

Author:

boonebgorges

Message:

Improved customizability for the Submit button in comment_form().

The new 'submit_button' and 'submit_field' parameters for comment_form()
allow developers to modify the markup of the submit button and its wrapper.
These params are accompanied by targeted 'comment_form_submit_button' and
'comment_form_submit_field' filters on the concatenated markup.

Props coffee2code, morpheu5, DrewAPicture, boonebgorges.
Fixes #15015.

Location:

trunk

Files:

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

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

@@ -2154 +2154 @@
  *
  * @since 3.0.0
+ * @since 4.2.0 Introduced 'submit_button' and 'submit_fields' arguments.
  *
  * @param array       $args {
@@ -2181 +2182 @@
  *     @type string $cancel_reply_link    The translatable 'cancel reply' button label. Default 'Cancel reply'.
  *     @type string $label_submit         The translatable 'submit' button label. Default 'Post a comment'.
+ *     @type string $submit_button        HTML format for the Submit button.
+ *                                        Default: '<input name="%1$s" type="submit" id="%2$s" class="%3$s" value="%4$s" />'.
+ *     @type string $submit_field         HTML format for the markup surrounding the Submit button and comment hidden
+ *                                        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'.
  * }
@@ -2237 +2243 @@
         'cancel_reply_link'    => __( 'Cancel reply' ),
         'label_submit'         => __( 'Post Comment' ),
+        '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',
     );
@@ -2351 +2359 @@
                         ?>
                         <?php echo $args['comment_notes_after']; ?>
-                        <p class="form-submit">
-                            <input name="<?php echo esc_attr( $args['name_submit'] ); ?>" type="submit" id="<?php echo esc_attr( $args['id_submit'] ); ?>" class="<?php echo esc_attr( $args['class_submit'] ); ?>" value="<?php echo esc_attr( $args['label_submit'] ); ?>" />
-                            <?php comment_id_fields( $post_id ); ?>
-                        </p>
+
                         <?php
+                        $submit_button = sprintf(
+                            $args['submit_button'],
+                            esc_attr( $args['name_submit'] ),
+                            esc_attr( $args['id_submit'] ),
+                            esc_attr( $args['class_submit'] ),
+                            esc_attr( $args['label_submit'] )
+                        );
+
+                        /**
+                         * Filter the submit button for the comment form to display.
+                         *
+                         * @since 4.2.0
+                         *
+                         * @param string $submit_button HTML markup for the submit button.
+                         * @param array  $args          Arguments passed to `comment_form()`.
+                         */
+                        $submit_button = apply_filters( 'comment_form_submit_button', $submit_button, $args );
+
+                        $submit_field = sprintf(
+                            $args['submit_field'],
+                            $submit_button,
+                            get_comment_id_fields( $post_id )
+                        );
+
+                        /**
+                         * Filter the submit field for the comment form to display.
+                         *
+                         * The submit field includes the submit button, hidden fields for the
+                         * comment form, and any wrapper markup.
+                         *
+                         * @since 4.2.0
+                         *
+                         * @param string $submit_field HTML markup for the submit field.
+                         * @param array  $args         Arguments passed to `comment_form()`.
+                         */
+                        echo apply_filters( 'comment_form_submit_field', $submit_field, $args );
+
                         /**
                          * Fires at the bottom of the comment form, inside the closing </form> tag.