<!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>[48208] trunk/src/wp-includes/comment.php: Comments: Rename the `$avoid_die` parameter of `wp_allow_comment()` and `wp_new_comment()` to `$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/48208">48208</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/48208","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>2020-06-28 22:08:22 +0000 (Sun, 28 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: Rename the `$avoid_die` parameter of `wp_allow_comment()` and `wp_new_comment()` to `$wp_error`.
This makes the function signatures more consistent with `wp_update_comment()` and `wp_set_comment_status()`.
`wp_check_comment_flood()` is left as the only function with the `$avoid_die` parameter for now, as it does not return a `WP_Error` object.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/48154">[48154]</a>, <a href="https://core.trac.wordpress.org/changeset/48207">[48207]</a>.
See <a href="https://core.trac.wordpress.org/ticket/39732">#39732</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludescommentphp">trunk/src/wp-includes/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 2020-06-28 21:40:54 UTC (rev 48207)
+++ trunk/src/wp-includes/comment.php 2020-06-28 22:08:22 UTC (rev 48208)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -656,19 +656,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Validates whether this comment is allowed to be made.
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since 4.7.0 The `$avoid_die` parameter was added, allowing the function to
- * return a WP_Error object instead of dying.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0 The `$avoid_die` parameter was added, allowing the function
+ * to return a WP_Error object instead of dying.
+ * @since 5.5.0 The `$avoid_die` parameter was renamed to `$wp_error`.
</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 $commentdata Contains information on the comment.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param bool $avoid_die When true, a disallowed comment will result in the function
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool $wp_error When true, a disallowed comment will result in the function
</ins><span class="cx" style="display: block; padding: 0 10px"> * returning a WP_Error object, rather than executing wp_die().
</span><span class="cx" style="display: block; padding: 0 10px"> * Default false.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return int|string|WP_Error Allowed comments return the approval status (0|1|'spam'|'trash').
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * If `$avoid_die` is true, disallowed comments return a WP_Error.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * If `$wp_error` is true, disallowed comments return a WP_Error.
</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_allow_comment( $commentdata, $avoid_die = false ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function wp_allow_comment( $commentdata, $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"> // Simple duplicate check.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -723,7 +724,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $comment_duplicate_message = apply_filters( 'comment_duplicate_message', __( 'Duplicate comment detected; it looks as though you’ve already said that!' ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( true === $avoid_die ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $wp_error ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return new WP_Error( 'comment_duplicate', $comment_duplicate_message, 409 );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( wp_doing_ajax() ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -741,12 +742,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.3.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.7.0 The `$avoid_die` parameter was added.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.5.0 The `$avoid_die` parameter was renamed to `$wp_error`.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $comment_author_IP Comment author's IP address.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $comment_author_email Comment author's email.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $comment_date_gmt GMT date the comment was posted.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param bool $avoid_die Whether to prevent executing wp_die()
- * or die() if a comment flood is occurring.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool $wp_error Whether to return a WP_Error object instead of executing
+ * wp_die() or die() if a comment flood is occurring.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> do_action(
</span><span class="cx" style="display: block; padding: 0 10px"> 'check_comment_flood',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -753,7 +755,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $commentdata['comment_author_IP'],
</span><span class="cx" style="display: block; padding: 0 10px"> $commentdata['comment_author_email'],
</span><span class="cx" style="display: block; padding: 0 10px"> $commentdata['comment_date_gmt'],
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $avoid_die
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $wp_error
</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 class="lines" style="display: block; padding: 0 10px; color: #888">@@ -762,13 +764,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * The default check is wp_check_comment_flood(). See check_comment_flood_db().
</span><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 The `$avoid_die` parameter was renamed to `$wp_error`.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param bool $is_flood Is a comment flooding occurring? Default false.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $comment_author_IP Comment author's IP address.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $comment_author_email Comment author's email.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $comment_date_gmt GMT date the comment was posted.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param bool $avoid_die Whether to prevent executing wp_die()
- * or die() if a comment flood is occurring.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool $wp_error Whether to return a WP_Error object instead of executing
+ * wp_die() or die() if a comment flood is occurring.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $is_flood = apply_filters(
</span><span class="cx" style="display: block; padding: 0 10px"> 'wp_is_comment_flood',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -776,7 +779,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $commentdata['comment_author_IP'],
</span><span class="cx" style="display: block; padding: 0 10px"> $commentdata['comment_author_email'],
</span><span class="cx" style="display: block; padding: 0 10px"> $commentdata['comment_date_gmt'],
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $avoid_die
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $wp_error
</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"> if ( $is_flood ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2139,8 +2142,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.3.0 Introduced the `comment_agent` and `comment_author_IP` arguments.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since 4.7.0 The `$avoid_die` parameter was added, allowing the function to
- * return a WP_Error object instead of dying.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0 The `$avoid_die` parameter was added, allowing the function
+ * to return a WP_Error object instead of dying.
+ * @since 5.5.0 The `$avoid_die` parameter was renamed to `$wp_error`.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.0 Introduced the `comment_type` argument.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @see wp_insert_comment()
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2166,11 +2170,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $comment_author_IP Comment author IP address in IPv4 format. Default is the value of
</span><span class="cx" style="display: block; padding: 0 10px"> * 'REMOTE_ADDR' in the `$_SERVER` superglobal sent in the original request.
</span><span class="cx" style="display: block; padding: 0 10px"> * }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param bool $avoid_die Should errors be returned as WP_Error objects instead of
- * executing wp_die()? Default false.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool $wp_error Should errors be returned as WP_Error objects instead of
+ * executing wp_die()? Default false.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return int|false|WP_Error The ID of the comment on success, false or WP_Error on failure.
</span><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_new_comment( $commentdata, $avoid_die = false ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function wp_new_comment( $commentdata, $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"> if ( isset( $commentdata['user_ID'] ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2227,7 +2231,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $commentdata = wp_filter_comment( $commentdata );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $commentdata['comment_approved'] = wp_allow_comment( $commentdata, $avoid_die );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $commentdata['comment_approved'] = wp_allow_comment( $commentdata, $wp_error );
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error( $commentdata['comment_approved'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return $commentdata['comment_approved'];
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2244,7 +2248,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $commentdata = wp_filter_comment( $commentdata );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $commentdata['comment_approved'] = wp_allow_comment( $commentdata, $avoid_die );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $commentdata['comment_approved'] = wp_allow_comment( $commentdata, $wp_error );
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error( $commentdata['comment_approved'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return $commentdata['comment_approved'];
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2415,7 +2419,7 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since 5.5.0 Allow returning a WP_Error object on failure.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.5.0 The `$wp_error` parameter was added.
</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="lines" style="display: block; padding: 0 10px; color: #888">@@ -2488,7 +2492,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * WP_Error object is preventing the comment to be updated.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.7.0
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since 5.5.0 Allow returning a WP_Error object on failure.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.5.0 The `$wp_error` parameter was added.
</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></pre>
</div>
</div>
</body>
</html>