<!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>[54368] trunk: Code Modernization: Correct default values in `wp_handle_comment_submission()`.</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/54368">54368</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/54368","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-03 15:20:49 +0000 (Mon, 03 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'>Code Modernization: Correct default values in `wp_handle_comment_submission()`.
This affects the following parameters subsequently passed to `wp_new_comment()`:
* `comment_author`
* `comment_author_email`
* `comment_author_url`
* `comment_content`
The default values for these parameters were previously set to `null`, causing PHP 8.1 "null to non-nullable" deprecation notices when running sanitization filters on them via `wp_filter_comment()`.
While the deprecation notices were temporarily silenced in the unit test suite, that caused an unexpected issue in a test for [source:tags/6.0.2/tests/phpunit/tests/comment-submission.php#L202 submitting a comment to a password protected post], where the `$_COOKIE[ 'wp-postpass_' . COOKIEHASH ]` value was no longer unset, as the test stopped any further execution once the deprecation notice was triggered.
Due to how WordPress handles password protected posts, once that value is set, it affects all posts protected with the same password, so this resulted in unintentionally affecting [source:tags/6.0.2/tests/phpunit/tests/rest-api/rest-posts-controller.php#L1866 another test] which happened to use the same password.
These values are all documented to be a string in various related filters, and core also expects them to be a string, so there is no reason for these defaults to be set to `null`. Setting them to an empty string instead resolves the issues.
This commit includes:
* Setting the defaults in `wp_handle_comment_submission()` to an empty string.
* Adding a dedicated unit test to verify the type of these default values.
* Removing the deprecation notice silencing as no longer needed.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/34799">[34799]</a>, <a href="https://core.trac.wordpress.org/changeset/34801">[34801]</a>, <a href="https://core.trac.wordpress.org/changeset/51968">[51968]</a>.
Props jrf, desrosj, mukesh27, SergeyBiryukov.
Fixes <a href="https://core.trac.wordpress.org/ticket/56712">#56712</a>. See <a href="https://core.trac.wordpress.org/ticket/56681">#56681</a>, <a href="https://core.trac.wordpress.org/ticket/55656">#55656</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>
</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-03 14:39:05 UTC (rev 54367)
+++ trunk/src/wp-includes/comment.php 2022-10-03 15:20:49 UTC (rev 54368)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3427,10 +3427,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_handle_comment_submission( $comment_data ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $comment_post_id = 0;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $comment_author = null;
- $comment_author_email = null;
- $comment_author_url = null;
- $comment_content = null;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $comment_author = '';
+ $comment_author_email = '';
+ $comment_author_url = '';
+ $comment_content = '';
</ins><span class="cx" style="display: block; padding: 0 10px"> $comment_parent = 0;
</span><span class="cx" style="display: block; padding: 0 10px"> $user_id = 0;
</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-03 14:39:05 UTC (rev 54367)
+++ trunk/tests/phpunit/tests/comment-submission.php 2022-10-03 15:20:49 UTC (rev 54368)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -223,16 +223,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_submitting_comment_to_password_protected_post_succeeds() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( PHP_VERSION_ID >= 80100 ) {
- /*
- * For the time being, ignoring PHP 8.1 "null to non-nullable" deprecations coming in
- * via hooked in filter functions until a more structural solution to the
- * "missing input validation" conundrum has been architected and implemented.
- */
- $this->expectDeprecation();
- $this->expectDeprecationMessageMatches( '`Passing null to parameter \#[0-9]+ \(\$[^\)]+\) of type [^ ]+ is deprecated`' );
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> $password = 'password';
</span><span class="cx" style="display: block; padding: 0 10px"> $hasher = new PasswordHash( 8, true );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -321,17 +311,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function test_submitting_comment_handles_slashes_correctly_handles_slashes() {
- if ( PHP_VERSION_ID >= 80100 ) {
- /*
- * For the time being, ignoring PHP 8.1 "null to non-nullable" deprecations coming in
- * via hooked in filter functions until a more structural solution to the
- * "missing input validation" conundrum has been architected and implemented.
- */
- $this->expectDeprecation();
- $this->expectDeprecationMessageMatches( '`Passing null to parameter \#[0-9]+ \(\$[^\)]+\) of type [^ ]+ is deprecated`' );
- }
-
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function test_submitting_comment_handles_slashes_correctly() {
</ins><span class="cx" style="display: block; padding: 0 10px"> $data = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'comment_post_ID' => self::$post->ID,
</span><span class="cx" style="display: block; padding: 0 10px"> 'comment' => 'Comment with 1 slash: \\',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -496,16 +476,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_anonymous_user_cannot_comment_unfiltered_html() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( PHP_VERSION_ID >= 80100 ) {
- /*
- * For the time being, ignoring PHP 8.1 "null to non-nullable" deprecations coming in
- * via hooked in filter functions until a more structural solution to the
- * "missing input validation" conundrum has been architected and implemented.
- */
- $this->expectDeprecation();
- $this->expectDeprecationMessageMatches( '`Passing null to parameter \#[0-9]+ \(\$[^\)]+\) of type [^ ]+ is deprecated`' );
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> $data = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'comment_post_ID' => self::$post->ID,
</span><span class="cx" style="display: block; padding: 0 10px"> 'comment' => 'Comment <script>alert(document.cookie);</script>',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -832,16 +802,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_submitting_comment_with_empty_type_results_in_correct_type() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( PHP_VERSION_ID >= 80100 ) {
- /*
- * For the time being, ignoring PHP 8.1 "null to non-nullable" deprecations coming in
- * via hooked in filter functions until a more structural solution to the
- * "missing input validation" conundrum has been architected and implemented.
- */
- $this->expectDeprecation();
- $this->expectDeprecationMessageMatches( '`Passing null to parameter \#[0-9]+ \(\$[^\)]+\) of type [^ ]+ is deprecated`' );
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> $data = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'comment_post_ID' => self::$post->ID,
</span><span class="cx" style="display: block; padding: 0 10px"> 'comment' => 'Comment',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -898,8 +858,6 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $comment = wp_handle_comment_submission( $data );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- remove_filter( 'preprocess_comment', array( $this, 'filter_preprocess_comment' ) );
-
</del><span class="cx" style="display: block; padding: 0 10px"> $this->assertNotWPError( $comment );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSameSetsWithIndex(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -920,6 +878,34 @@
</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 56712
+ *
+ * @covers ::wp_handle_comment_submission
+ */
+ public function test_submitting_comment_without_optional_parameters_sets_them_to_empty_strings() {
+ $data = array(
+ 'comment_post_ID' => self::$post->ID,
+ );
+
+ add_filter( 'pre_option_require_name_email', '__return_zero' );
+ add_filter( 'allow_empty_comment', '__return_true' );
+
+ add_filter( 'preprocess_comment', array( $this, 'filter_preprocess_comment' ) );
+
+ $comment = wp_handle_comment_submission( $data );
+
+ $this->assertNotWPError( $comment );
+ $this->assertInstanceOf( 'WP_Comment', $comment );
+
+ $commentdata = $this->preprocess_comment_data;
+
+ $this->assertSame( '', $commentdata['comment_author'], 'Comment author should default to an empty string.' );
+ $this->assertSame( '', $commentdata['comment_author_email'], 'Comment author email should default to an empty string.' );
+ $this->assertSame( '', $commentdata['comment_author_url'], 'Comment author URL should default to an empty string.' );
+ $this->assertSame( '', $commentdata['comment_content'], 'Comment content should default to an empty string.' );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function filter_preprocess_comment( $commentdata ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->preprocess_comment_data = $commentdata;
</span><span class="cx" style="display: block; padding: 0 10px"> return $commentdata;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -931,16 +917,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_submitting_duplicate_comments() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( PHP_VERSION_ID >= 80100 ) {
- /*
- * For the time being, ignoring PHP 8.1 "null to non-nullable" deprecations coming in
- * via hooked in filter functions until a more structural solution to the
- * "missing input validation" conundrum has been architected and implemented.
- */
- $this->expectDeprecation();
- $this->expectDeprecationMessageMatches( '`Passing null to parameter \#[0-9]+ \(\$[^\)]+\) of type [^ ]+ is deprecated`' );
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> $data = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'comment_post_ID' => self::$post->ID,
</span><span class="cx" style="display: block; padding: 0 10px"> 'comment' => 'Did I say that?',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -959,16 +935,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_comments_flood() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( PHP_VERSION_ID >= 80100 ) {
- /*
- * For the time being, ignoring PHP 8.1 "null to non-nullable" deprecations coming in
- * via hooked in filter functions until a more structural solution to the
- * "missing input validation" conundrum has been architected and implemented.
- */
- $this->expectDeprecation();
- $this->expectDeprecationMessageMatches( '`Passing null to parameter \#[0-9]+ \(\$[^\)]+\) of type [^ ]+ is deprecated`' );
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> $data = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'comment_post_ID' => self::$post->ID,
</span><span class="cx" style="display: block; padding: 0 10px"> 'comment' => 'Did I say that?',
</span></span></pre>
</div>
</div>
</body>
</html>