<!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>[47286] trunk/src/wp-includes/comment.php: Docs: Update `@return` tag for `wp_allow_comment()` with `trash` as a possible return value.</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/47286">47286</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/47286","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-02-13 17:48:50 +0000 (Thu, 13 Feb 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'>Docs: Update `@return` tag for `wp_allow_comment()` with `trash` as a possible return value.

Props oakesjosh, jeremyfelt.

Fixes <a href="https://core.trac.wordpress.org/ticket/49206">#49206</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-02-12 11:52:11 UTC (rev 47285)

+++ trunk/src/wp-includes/comment.php   2020-02-13 17:48:50 UTC (rev 47286)

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -651,7 +651,7 @@

</span><span class="cx" style="display: block; padding: 0 10px">  * @param bool  $avoid_die   When true, a disallowed comment will result in the function

<span class="cx" style="display: block; padding: 0 10px">  *                           returning a WP_Error object, rather than executing wp_die().

<span class="cx" style="display: block; padding: 0 10px">  *                           Default false.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return int|string|WP_Error Allowed comments return the approval status (0|1|'spam').

</ins><span class="cx" style="display: block; padding: 0 10px">  *                             If `$avoid_die` is true, disallowed comments return a WP_Error.

</span><span class="cx" style="display: block; padding: 0 10px">  */

</span><span class="cx" style="display: block; padding: 0 10px"> function wp_allow_comment( $commentdata, $avoid_die = false ) {

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -817,14 +817,14 @@

<span class="cx" style="display: block; padding: 0 10px">         * Filters a comment's approval status before it is set.

</span><span class="cx" style="display: block; padding: 0 10px">         *

</span><span class="cx" style="display: block; padding: 0 10px">         * @since 2.1.0

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * @since 4.9.0 Returning a WP_Error value from the filter will shortcircuit comment insertion and

-        *              allow skipping further processing.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * @since 4.9.0 Returning a WP_Error value from the filter will shortcircuit comment insertion

+        *              and allow skipping further processing.

</ins><span class="cx" style="display: block; padding: 0 10px">          *

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * @param int|string|WP_Error $approved    The approval status. Accepts 1, 0, 'spam' or WP_Error.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * @param int|string|WP_Error $approved    The approval status. Accepts 1, 0, 'spam', 'trash',

+        *                                         or WP_Error.

</ins><span class="cx" style="display: block; padding: 0 10px">          * @param array               $commentdata Comment 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">-        $approved = apply_filters( 'pre_comment_approved', $approved, $commentdata );

-       return $approved;

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return apply_filters( 'pre_comment_approved', $approved, $commentdata );

</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>

</div>

</body>

</html>