<!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>[54489] trunk: Comments: Consistently normalize `user_ID` to `user_id` in `wp_new_comment()`.</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 { white-space: pre-line; 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/54489">54489</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/54489","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>2022-10-11 16:30:40 +0000 (Tue, 11 Oct 2022)</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: Consistently normalize `user_ID` to `user_id` in `wp_new_comment()`.
For backward compatibility, the `user_id` parameter of `wp_new_comment()` can be spelled as `user_ID`, and plugins utilizing the `preprocess_comment` filter or the `comment_post` action should be able to receive both variations.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/12267">[12267]</a>, <a href="https://core.trac.wordpress.org/changeset/12300">[12300]</a>, <a href="https://core.trac.wordpress.org/changeset/28915">[28915]</a>, <a href="https://core.trac.wordpress.org/changeset/36038">[36038]</a>, <a href="https://core.trac.wordpress.org/changeset/53729">[53729]</a>.
Props peterwilsoncc, SergeyBiryukov.
Fixes <a href="https://core.trac.wordpress.org/ticket/56244">#56244</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludescommentphp">trunk/src/wp-includes/comment.php</a></li>
<li><a href="#trunktestsphpunittestscommentsubmissionphp">trunk/tests/phpunit/tests/comment-submission.php</a></li>
<li><a href="#trunktestsphpunittestscommentphp">trunk/tests/phpunit/tests/comment.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludescommentphp"></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.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/comment.php 2022-10-11 15:43:04 UTC (rev 54488)
+++ trunk/src/wp-includes/comment.php 2022-10-11 16:30:40 UTC (rev 54489)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2208,9 +2208,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_new_comment( $commentdata, $wp_error = false ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wpdb;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * Normalize `user_ID` to `user_id`, but pass the old key
+ * to the `preprocess_comment` filter for backward compatibility.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $commentdata['user_ID'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $commentdata['user_ID'] = (int) $commentdata['user_ID'];
</span><span class="cx" style="display: block; padding: 0 10px"> $commentdata['user_id'] = $commentdata['user_ID'];
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } elseif ( isset( $commentdata['user_id'] ) ) {
+ $commentdata['user_id'] = (int) $commentdata['user_id'];
+ $commentdata['user_ID'] = $commentdata['user_id'];
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $prefiltered_user_id = ( isset( $commentdata['user_id'] ) ) ? (int) $commentdata['user_id'] : 0;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2235,11 +2242,13 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $commentdata['comment_post_ID'] = (int) $commentdata['comment_post_ID'];
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Normalize `user_ID` to `user_id` again, after the filter.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $commentdata['user_ID'] ) && $prefiltered_user_id !== (int) $commentdata['user_ID'] ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $commentdata['user_ID'] = (int) $commentdata['user_ID'];
</span><span class="cx" style="display: block; padding: 0 10px"> $commentdata['user_id'] = $commentdata['user_ID'];
</span><span class="cx" style="display: block; padding: 0 10px"> } elseif ( isset( $commentdata['user_id'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $commentdata['user_id'] = (int) $commentdata['user_id'];
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $commentdata['user_ID'] = $commentdata['user_id'];
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $commentdata['comment_parent'] = isset( $commentdata['comment_parent'] ) ? absint( $commentdata['comment_parent'] ) : 0;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3587,7 +3596,6 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $commentdata = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'comment_post_ID' => $comment_post_id,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'user_ID' => $user_id,
</del><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $commentdata += compact(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3596,7 +3604,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'comment_author_url',
</span><span class="cx" style="display: block; padding: 0 10px"> 'comment_content',
</span><span class="cx" style="display: block; padding: 0 10px"> 'comment_type',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'comment_parent'
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'comment_parent',
+ 'user_id'
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span></span></pre></div>
<a id="trunktestsphpunittestscommentsubmissionphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/comment-submission.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/comment-submission.php 2022-10-11 15:43:04 UTC (rev 54488)
+++ trunk/tests/phpunit/tests/comment-submission.php 2022-10-11 16:30:40 UTC (rev 54489)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -845,7 +845,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @covers ::wp_handle_comment_submission
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_comment_submission_sends_all_expected_parameters_to_preprocess_comment_filter() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
</del><span class="cx" style="display: block; padding: 0 10px"> $user = get_userdata( self::$author_id );
</span><span class="cx" style="display: block; padding: 0 10px"> wp_set_current_user( $user->ID );
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunktestsphpunittestscommentphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/comment.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/comment.php 2022-10-11 15:43:04 UTC (rev 54488)
+++ trunk/tests/phpunit/tests/comment.php 2022-10-11 16:30:40 UTC (rev 54489)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -8,6 +8,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> protected static $post_id;
</span><span class="cx" style="display: block; padding: 0 10px"> protected static $notify_message = '';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ protected $preprocess_comment_data = array();
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function set_up() {
</span><span class="cx" style="display: block; padding: 0 10px"> parent::set_up();
</span><span class="cx" style="display: block; padding: 0 10px"> reset_phpmailer_instance();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -457,6 +459,53 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @ticket 56244
+ */
+ public function test_wp_new_comment_sends_all_expected_parameters_to_preprocess_comment_filter() {
+ $user = get_userdata( self::$user_id );
+ wp_set_current_user( $user->ID );
+
+ $data = array(
+ 'comment_post_ID' => self::$post_id,
+ 'comment_author' => $user->display_name,
+ 'comment_author_email' => $user->user_email,
+ 'comment_author_url' => $user->user_url,
+ 'comment_content' => 'Comment',
+ 'comment_type' => '',
+ 'comment_parent' => 0,
+ 'user_id' => $user->ID,
+ );
+
+ add_filter( 'preprocess_comment', array( $this, 'filter_preprocess_comment' ) );
+
+ $comment = wp_new_comment( $data );
+
+ $this->assertNotWPError( $comment );
+ $this->assertSameSetsWithIndex(
+ array(
+ 'comment_post_ID' => self::$post_id,
+ 'comment_author' => $user->display_name,
+ 'comment_author_email' => $user->user_email,
+ 'comment_author_url' => $user->user_url,
+ 'comment_content' => $data['comment_content'],
+ 'comment_type' => '',
+ 'comment_parent' => 0,
+ 'user_ID' => $user->ID,
+ 'user_id' => $user->ID,
+ 'comment_author_IP' => '127.0.0.1',
+ 'comment_agent' => '',
+ ),
+ $this->preprocess_comment_data
+ );
+
+ }
+
+ public function filter_preprocess_comment( $commentdata ) {
+ $this->preprocess_comment_data = $commentdata;
+ return $commentdata;
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 32566
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @covers ::wp_notify_moderator
</span></span></pre>
</div>
</div>
</body>
</html>