<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[35723] trunk/src/wp-includes/comment-template.php: Comments: In `comment_form()`, introduce the `comment_form_fields` filter for comment fields, including the textarea.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/35723">35723</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/35723","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-11-20 18:55:31 +0000 (Fri, 20 Nov 2015)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Comments: In `comment_form()`, introduce the `comment_form_fields` filter for comment fields, including the textarea.
Correct the docs for `comment_notes_before` and `comment_notes_after` arguments as well as `comment_form_before_fields` and `comment_form_after_fields` actions to better describe the current behaviour.
Fixes <a href="https://core.trac.wordpress.org/ticket/34731">#34731</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludescommenttemplatephp">trunk/src/wp-includes/comment-template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludescommenttemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/comment-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/comment-template.php 2015-11-20 17:45:57 UTC (rev 35722)
+++ trunk/src/wp-includes/comment-template.php 2015-11-20 18:55:31 UTC (rev 35723)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2037,9 +2037,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $comment_field The comment textarea field HTML.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $must_log_in HTML element for a 'must be logged in to comment' message.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $logged_in_as HTML element for a 'logged in as [user]' message.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type string $comment_notes_before HTML element for a message displayed before the comment form.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $comment_notes_before HTML element for a message displayed before the comment fields
+ * if the user is not logged in.
</ins><span class="cx" style="display: block; padding: 0 10px"> * Default 'Your email address will not be published.'.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type string $comment_notes_after HTML element for a message displayed after the comment form.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $comment_notes_after HTML element for a message displayed after the textarea field.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @type string $id_form The comment form element id attribute. Default 'commentform'.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $id_submit The comment submit element id attribute. Default 'submit'.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $class_form The comment form element class attribute. Default 'comment-form'.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2214,26 +2215,52 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> endif;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Prepare an array of all fields, including the textarea
+ $comment_fields = array( 'comment' => $args['comment_field'] ) + (array) $args['fields'];
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Filter the content of the comment textarea field for display.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filter the comment form fields.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since 3.0.0
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.4.0
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $args_comment_field The content of the comment textarea field.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $comment_fields The comment fields.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- echo apply_filters( 'comment_form_field_comment', $args['comment_field'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $comment_fields = apply_filters( 'comment_form_fields', $comment_fields );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- echo $args['comment_notes_after'];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Get an array of field names, excluding the textarea
+ $comment_field_keys = array_diff( array_keys( $comment_fields ), array( 'comment' ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! is_user_logged_in() ) :
- /**
- * Fires before the comment fields in the comment form.
- *
- * @since 3.0.0
- */
- do_action( 'comment_form_before_fields' );
- foreach ( (array) $args['fields'] as $name => $field ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Get the first and the last field name, excluding the textarea
+ $first_field = reset( $comment_field_keys );
+ $last_field = end( $comment_field_keys );
+
+ foreach ( $comment_fields as $name => $field ) {
+
+ if ( 'comment' === $name ) {
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filter the content of the comment textarea field for display.
+ *
+ * @since 3.0.0
+ *
+ * @param string $args_comment_field The content of the comment textarea field.
+ */
+ echo apply_filters( 'comment_form_field_comment', $field );
+
+ echo $args['comment_notes_after'];
+
+ } elseif ( ! is_user_logged_in() ) {
+
+ if ( $first_field === $name ) {
+ /**
+ * Fires before the comment fields in the comment form, excluding the textarea.
+ *
+ * @since 3.0.0
+ */
+ do_action( 'comment_form_before_fields' );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Filter a comment form field for display.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * The dynamic portion of the filter hook, `$name`, refers to the name
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2244,16 +2271,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $field The HTML-formatted output of the comment form field.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> echo apply_filters( "comment_form_field_{$name}", $field ) . "\n";
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ if ( $last_field === $name ) {
+ /**
+ * Fires after the comment fields in the comment form, excluding the textarea.
+ *
+ * @since 3.0.0
+ */
+ do_action( 'comment_form_after_fields' );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /**
- * Fires after the comment fields in the comment form.
- *
- * @since 3.0.0
- */
- do_action( 'comment_form_after_fields' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- endif;
-
</del><span class="cx" style="display: block; padding: 0 10px"> $submit_button = sprintf(
</span><span class="cx" style="display: block; padding: 0 10px"> $args['submit_button'],
</span><span class="cx" style="display: block; padding: 0 10px"> esc_attr( $args['name_submit'] ),
</span></span></pre>
</div>
</div>
</body>
</html>