<!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>[48154] trunk: Comments: Allow `wp_update_comment()` to return `WP_Error()`.</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/48154">48154</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/48154","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>whyisjake</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-06-24 00:03:33 +0000 (Wed, 24 Jun 2020)</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: Allow `wp_update_comment()` to return `WP_Error()`.
The `wp_update_comment_data` filter introduced in 4.7 allows comment data to be filtered before it is updated in the database.
The patch aims to handle `WP_Error` as the filter above return value in a similar manner as is done for `wp_new_comment()`.
Fixes <a href="https://core.trac.wordpress.org/ticket/39732">#39732</a>.
Props: enricosorcinelli, swissspidy, gkloveweb, jnylen0, jbpaul17, afercia, SergeyBiryukov, audrasjb, imath, davidbaumwald.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadmincommentphp">trunk/src/wp-admin/comment.php</a></li>
<li><a href="#trunksrcwpadminincludesajaxactionsphp">trunk/src/wp-admin/includes/ajax-actions.php</a></li>
<li><a href="#trunksrcwpadminincludescommentphp">trunk/src/wp-admin/includes/comment.php</a></li>
<li><a href="#trunksrcwpincludesclasswpxmlrpcserverphp">trunk/src/wp-includes/class-wp-xmlrpc-server.php</a></li>
<li><a href="#trunksrcwpincludescommentphp">trunk/src/wp-includes/comment.php</a></li>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestcommentscontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php</a></li>
<li><a href="#trunktestsphpunittestsajaxEditCommentphp">trunk/tests/phpunit/tests/ajax/EditComment.php</a></li>
<li><a href="#trunktestsphpunittestscommentphp">trunk/tests/phpunit/tests/comment.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestcommentscontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-comments-controller.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadmincommentphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/comment.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/comment.php 2020-06-23 23:42:36 UTC (rev 48153)
+++ trunk/src/wp-admin/comment.php 2020-06-24 00:03:33 UTC (rev 48154)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -339,7 +339,10 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> check_admin_referer( 'update-comment_' . $comment_id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- edit_comment();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $updated = edit_comment();
+ if ( is_wp_error( $updated ) ) {
+ wp_die( $updated->get_error_message() );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $location = ( empty( $_POST['referredby'] ) ? "edit-comments.php?p=$comment_post_id" : $_POST['referredby'] ) . '#comment-' . $comment_id;
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunksrcwpadminincludesajaxactionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/ajax-actions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/ajax-actions.php 2020-06-23 23:42:36 UTC (rev 48153)
+++ trunk/src/wp-admin/includes/ajax-actions.php 2020-06-24 00:03:33 UTC (rev 48154)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1410,8 +1410,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $_POST['status'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $_POST['comment_status'] = $_POST['status'];
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- edit_comment();
</del><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $updated = edit_comment();
+ if ( is_wp_error( $updated ) ) {
+ wp_die( $updated->get_error_message() );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $position = ( isset( $_POST['position'] ) && (int) $_POST['position'] ) ? (int) $_POST['position'] : '-1';
</span><span class="cx" style="display: block; padding: 0 10px"> $checkbox = ( isset( $_POST['checkbox'] ) && true == $_POST['checkbox'] ) ? 1 : 0;
</span><span class="cx" style="display: block; padding: 0 10px"> $wp_list_table = _get_list_table( $checkbox ? 'WP_Comments_List_Table' : 'WP_Post_Comments_List_Table', array( 'screen' => 'edit-comments' ) );
</span></span></pre></div>
<a id="trunksrcwpadminincludescommentphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/comment.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/comment.php 2020-06-23 23:42:36 UTC (rev 48153)
+++ trunk/src/wp-admin/includes/comment.php 2020-06-24 00:03:33 UTC (rev 48154)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -92,7 +92,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $_POST['comment_date'] = "$aa-$mm-$jj $hh:$mn:$ss";
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- wp_update_comment( $_POST );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return wp_update_comment( $_POST, true );
</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="trunksrcwpincludesclasswpxmlrpcserverphp"></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/class-wp-xmlrpc-server.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-xmlrpc-server.php 2020-06-23 23:42:36 UTC (rev 48153)
+++ trunk/src/wp-includes/class-wp-xmlrpc-server.php 2020-06-24 00:03:33 UTC (rev 48154)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3788,8 +3788,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $comment['comment_author_email'] = $content_struct['author_email'];
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $result = wp_update_comment( $comment );
- if ( is_wp_error( $result ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $result = wp_update_comment( $comment, true );
+ if ( is_wp_error( $result ) || false === $result ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return new IXR_Error( 500, $result->get_error_message() );
</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="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 2020-06-23 23:42:36 UTC (rev 48153)
+++ trunk/src/wp-includes/comment.php 2020-06-24 00:03:33 UTC (rev 48154)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2405,24 +2405,35 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.9.0 Add updating comment meta during comment update.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.5.0 Allow returning a WP_Error object on failure.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @global wpdb $wpdb WordPress database abstraction object.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $commentarr Contains information on the comment.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return int The value 1 if the comment was updated, 0 if not updated.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool $wp_error Optional. Whether to return a WP_Error on failure. Default false.
+ * @return int|bool|WP_Error Comment was updated if value is 1, or was not updated if value is 0,
+ * false, or a WP_Error object.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function wp_update_comment( $commentarr ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function wp_update_comment( $commentarr, $wp_error = false ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> global $wpdb;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // First, get all of the original fields.
</span><span class="cx" style="display: block; padding: 0 10px"> $comment = get_comment( $commentarr['comment_ID'], ARRAY_A );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $comment ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return 0;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! $wp_error ) {
+ return 0;
+ }
+
+ return new WP_Error( 'invalid_comment_id', __( 'Invalid comment 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"> // Make sure that the comment post ID is valid (if specified).
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $commentarr['comment_post_ID'] ) && ! get_post( $commentarr['comment_post_ID'] ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return 0;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! $wp_error ) {
+ return 0;
+ }
+
+ return new WP_Error( 'invalid_post_id', __( 'Invalid post 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"> // Escape data pulled from DB.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2463,16 +2474,25 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the comment data immediately before it is updated in the database.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Note: data being passed to the filter is already unslashed.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Note: data being passed to the filter is already unslashed. Returning 0 or a
+ * WP_Error object is preventing the comment to be updated.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.7.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.5.0 Allow returning a WP_Error object on failure.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $data The new, processed comment data.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $comment The old, unslashed comment data.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $commentarr The new, raw comment data.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool $wp_error Optional. Whether to return a WP_Error on failure.
+ * Default false.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $data = apply_filters( 'wp_update_comment_data', $data, $comment, $commentarr );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $data = apply_filters( 'wp_update_comment_data', $data, $comment, $commentarr, $wp_error );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Do not carry on on failure.
+ if ( is_wp_error( $data ) || 0 === $data ) {
+ return $data;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $keys = array( 'comment_post_ID', 'comment_content', 'comment_author', 'comment_author_email', 'comment_approved', 'comment_karma', 'comment_author_url', 'comment_date', 'comment_date_gmt', 'comment_type', 'comment_parent', 'user_id', 'comment_agent', 'comment_author_IP' );
</span><span class="cx" style="display: block; padding: 0 10px"> $data = wp_array_slice_assoc( $data, $keys );
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunksrcwpincludesrestapiendpointsclasswprestcommentscontrollerphp"></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/rest-api/endpoints/class-wp-rest-comments-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php 2020-06-23 23:42:36 UTC (rev 48153)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php 2020-06-24 00:03:33 UTC (rev 48154)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -868,9 +868,9 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $updated = wp_update_comment( wp_slash( (array) $prepared_args ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $updated = wp_update_comment( wp_slash( (array) $prepared_args ), true );
</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 ( false === $updated ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( is_wp_error( $updated ) || false === $updated ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return new WP_Error(
</span><span class="cx" style="display: block; padding: 0 10px"> 'rest_comment_failed_edit',
</span><span class="cx" style="display: block; padding: 0 10px"> __( 'Updating comment failed.' ),
</span></span></pre></div>
<a id="trunktestsphpunittestsajaxEditCommentphp"></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/ajax/EditComment.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/ajax/EditComment.php 2020-06-23 23:42:36 UTC (rev 48153)
+++ trunk/tests/phpunit/tests/ajax/EditComment.php 2020-06-24 00:03:33 UTC (rev 48154)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -32,6 +32,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->_comment_post = get_post( $post_id );
</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">+ public function tearDown() {
+ remove_filter( 'wp_update_comment_data', array( $this, '_wp_update_comment_data_filter' ), 10, 3 );
+ parent::tearDown();
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Get comments as a privilged user (administrator)
</span><span class="cx" style="display: block; padding: 0 10px"> * Expects test to pass
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -127,6 +132,41 @@
</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 39732
+ */
+ public function test_wp_update_comment_data_is_wp_error() {
+ // Become an administrator
+ $this->_setRole( 'administrator' );
+
+ // Get a comment
+ $comments = get_comments(
+ array(
+ 'post_id' => $this->_comment_post->ID,
+ )
+ );
+ $comment = array_pop( $comments );
+
+ // Set up a default request
+ $_POST['_ajax_nonce-replyto-comment'] = wp_create_nonce( 'replyto-comment' );
+ $_POST['comment_ID'] = $comment->comment_ID;
+ $_POST['content'] = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.';
+
+ // Simulate filter check error
+ add_filter( 'wp_update_comment_data', array( $this, '_wp_update_comment_data_filter' ), 10, 3 );
+
+ // Make the request
+ $this->setExpectedException( 'WPAjaxDieStopException', 'wp_update_comment_data filter fails for this comment.' );
+ $this->_handleAjax( 'edit-comment' );
+ }
+
+ /**
+ * Block comments from being updated by returning WP_Error
+ */
+ public function _wp_update_comment_data_filter( $data, $comment, $commentarr ) {
+ return new WP_Error( 'comment_wrong', __( 'wp_update_comment_data filter fails for this comment.' ), 500 );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Get comments as a non-privileged user (subscriber)
</span><span class="cx" style="display: block; padding: 0 10px"> * Expects test to fail
</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 2020-06-23 23:42:36 UTC (rev 48153)
+++ trunk/tests/phpunit/tests/comment.php 2020-06-24 00:03:33 UTC (rev 48154)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -142,6 +142,31 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $updated_comment_text, $comment->comment_content );
</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 39732
+ */
+ public function test_wp_update_comment_is_wp_error() {
+ $comment_id = self::factory()->comment->create( array( 'comment_post_ID' => self::$post_id ) );
+
+ add_filter( 'wp_update_comment_data', array( $this, '_wp_update_comment_data_filter' ), 10, 3 );
+ $result = wp_update_comment(
+ array(
+ 'comment_ID' => $comment_id,
+ 'comment_type' => 'pingback',
+ ),
+ true
+ );
+ $this->assertWPError( $result );
+ remove_filter( 'wp_update_comment_data', array( $this, '_wp_update_comment_data_filter' ), 10, 3 );
+ }
+
+ /**
+ * Block comments from being updated by returning WP_Error
+ */
+ public function _wp_update_comment_data_filter( $data, $comment, $commentarr ) {
+ return new WP_Error( 'comment_wrong', __( 'wp_update_comment_data filter fails for this comment.' ), 500 );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_get_approved_comments() {
</span><span class="cx" style="display: block; padding: 0 10px"> $ca1 = self::factory()->comment->create(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapirestcommentscontrollerphp"></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/rest-api/rest-comments-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/rest-comments-controller.php 2020-06-23 23:42:36 UTC (rev 48153)
+++ trunk/tests/phpunit/tests/rest-api/rest-comments-controller.php 2020-06-24 00:03:33 UTC (rev 48154)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2790,6 +2790,36 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertErrorResponse( 'comment_content_column_length', $response, 400 );
</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 39732
+ */
+ public function test_update_comment_is_wp_error() {
+ wp_set_current_user( self::$admin_id );
+
+ $params = array(
+ 'content' => 'This isn\'t a saxophone. It\'s an umbrella.',
+ );
+
+ add_filter( 'wp_update_comment_data', array( $this, '_wp_update_comment_data_filter' ), 10, 3 );
+
+ $request = new WP_REST_Request( 'PUT', sprintf( '/wp/v2/comments/%d', self::$approved_id ) );
+
+ $request->add_header( 'content-type', 'application/json' );
+ $request->set_body( wp_json_encode( $params ) );
+ $response = rest_get_server()->dispatch( $request );
+
+ $this->assertErrorResponse( 'rest_comment_failed_edit', $response, 500 );
+
+ remove_filter( 'wp_update_comment_data', array( $this, '_wp_update_comment_data_filter' ), 10, 3 );
+ }
+
+ /**
+ * Block comments from being updated by returning WP_Error
+ */
+ public function _wp_update_comment_data_filter( $data, $comment, $commentarr ) {
+ return new WP_Error( 'comment_wrong', __( 'wp_update_comment_data filter fails for this comment.' ), array( 'status' => 500 ) );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function verify_comment_roundtrip( $input = array(), $expected_output = array() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // Create the comment.
</span><span class="cx" style="display: block; padding: 0 10px"> $request = new WP_REST_Request( 'POST', '/wp/v2/comments' );
</span></span></pre>
</div>
</div>
</body>
</html>