<!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>[32587] trunk/src/wp-includes/comment.php: Add missing doc blocks to `comment.php`.</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 { 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/32587">32587</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/32587","name":"Review Commit"}}</script></dd>

<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>wonderboymusic</dd>

<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-05-24 21:03:42 +0000 (Sun, 24 May 2015)</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'>Add missing doc blocks to `comment.php`.

See <a href="https://core.trac.wordpress.org/ticket/32444">#32444</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 2015-05-24 20:34:07 UTC (rev 32586)

+++ trunk/src/wp-includes/comment.php   2015-05-24 21:03:42 UTC (rev 32587)

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

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

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @global wpdb $wpdb WordPress database abstraction object.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global wpdb   $wpdb WordPress database abstraction object.

+ * @global object $comment

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

<span class="cx" style="display: block; padding: 0 10px">  * @param object|string|int $comment Comment to retrieve.

<span class="cx" style="display: block; padding: 0 10px">  * @param string $output Optional. OBJECT or ARRAY_A or ARRAY_N constants.

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

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

<span class="cx" style="display: block; padding: 0 10px">         * @param callable $name      Method to call.

<span class="cx" style="display: block; padding: 0 10px">         * @param array    $arguments Arguments to pass when calling.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * @return mixed|bool Return value of the callback, false otherwise.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * @return mixed|false Return value of the callback, false otherwise.

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

</span><span class="cx" style="display: block; padding: 0 10px">        public function __call( $name, $arguments ) {

</span><span class="cx" style="display: block; padding: 0 10px">                if ( 'get_search_sql' === $name ) {

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

<span class="cx" style="display: block; padding: 0 10px">         *     @type array        $type__not_in        Exclude comments from a given array of comment types. Default empty.

<span class="cx" style="display: block; padding: 0 10px">         *     @type int          $user_id             Include comments for a specific user ID. Default empty.

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

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * @return WP_Comment_Query WP_Comment_Query instance.

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

</span><span class="cx" style="display: block; padding: 0 10px">        public function __construct( $query = '' ) {

</span><span class="cx" style="display: block; padding: 0 10px">                $this->query_var_defaults = array(

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

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

<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">         *

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * @return array The list of comments.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * @return int|array The list of comments.

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

</span><span class="cx" style="display: block; padding: 0 10px">        public function get_comments() {

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

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

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

</span><span class="cx" style="display: block; padding: 0 10px">         * Used internally to generate an SQL string for searching across multiple columns

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

</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         * @since 3.1.0

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

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * @since 3.1.0

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

</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         * @global wpdb $wpdb

+        *

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

</span><span class="cx" style="display: block; padding: 0 10px">         * @param array $cols

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

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

<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 class="cx" style="display: block; padding: 0 10px">         * @param string $orderby Alias for the field to order by.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * @return string|bool Value to used in the ORDER clause. False otherwise.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * @return string|false Value to used in the ORDER clause. False otherwise.

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

</span><span class="cx" style="display: block; padding: 0 10px">        protected function parse_orderby( $orderby ) {

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

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

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

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

<span class="cx" style="display: block; padding: 0 10px">  * @global wpdb $wpdb WordPress database abstraction object.

</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @staticvar array $cache_lastcommentmodified

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

</span><span class="cx" style="display: block; padding: 0 10px">  * @param string $timezone Which timezone to use in reference to 'gmt', 'blog',

<span class="cx" style="display: block; padding: 0 10px">  *             or 'server' locations.

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

<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">- * @return mixed Signifies the approval status (0|1|'spam')

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return int|string Signifies the approval status (0|1|'spam')

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

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

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

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

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

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

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

</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global WP_Query $wp_query

+ *

</ins><span class="cx" style="display: block; padding: 0 10px">  * @param array $comments Optional array of comment objects. Defaults to $wp_query->comments

<span class="cx" style="display: block; padding: 0 10px">  * @param int $per_page Optional comments per page.

<span class="cx" style="display: block; padding: 0 10px">  * @param boolean $threaded Optional control over flat or threaded comments.

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

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

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

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

</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global wpdb $wpdb

+ *

</ins><span class="cx" style="display: block; padding: 0 10px">  * @param int $comment_ID Comment ID.

<span class="cx" style="display: block; padding: 0 10px">  * @param array $args Optional args.

<span class="cx" style="display: block; padding: 0 10px">  * @return int|null Comment page number or null on error.

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

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

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

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

</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global wpdb $wpdb

+ *

</ins><span class="cx" style="display: block; padding: 0 10px">  * @param int $post_id Optional. Post ID.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return object Comment stats.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return object|array Comment stats.

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

</span><span class="cx" style="display: block; padding: 0 10px"> function wp_count_comments( $post_id = 0 ) {

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

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

<span class="cx" style="display: block; padding: 0 10px">  *     @type string     $comment_type         Comment type. Default empty.

<span class="cx" style="display: block; padding: 0 10px">  *     @type int        $user_id              ID of the user who submitted the comment. Default 0.

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

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return int|bool The new comment's ID on success, false on failure.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return int|false The new comment's ID on success, false on failure.

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

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

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

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

</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="cx" style="display: block; padding: 0 10px">  *

</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global wpdb $wpdb

+ *

</ins><span class="cx" style="display: block; padding: 0 10px">  * @param array $commentdata Contains information on the comment. See wp_insert_comment()

<span class="cx" style="display: block; padding: 0 10px">  *                           for information on accepted arguments.

<span class="cx" style="display: block; padding: 0 10px">  * @return int|false The ID of the comment on success, false on failure.

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

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

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

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

</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * global wpdb $wpdb

+ *

</ins><span class="cx" style="display: block; padding: 0 10px">  * @param int $comment_id Comment ID.

<span class="cx" style="display: block; padding: 0 10px">  * @param string $comment_status New comment status, either 'hold', 'approve', 'spam', or 'trash'.

<span class="cx" style="display: block; padding: 0 10px">  * @param bool $wp_error Whether to return a WP_Error object if there is a failure. Default is false.

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

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

</span><span class="cx" style="display: block; padding: 0 10px">  * @param int $post_id Post ID

</span><span class="cx" style="display: block; padding: 0 10px">  * @param bool $do_deferred Whether to process previously deferred post comment counts

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return bool|null True on success, false on failure

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool|void True on success, false on failure

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

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

</span><span class="cx" style="display: block; padding: 0 10px">        static $_deferred = array();

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

<span class="cx" style="display: block; padding: 0 10px">  * Pings back the links found in a post.

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

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

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @uses $wp_version

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

</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global string $wp_version

+ *

</ins><span class="cx" style="display: block; padding: 0 10px">  * @param string $content Post content to check for links.

<span class="cx" style="display: block; padding: 0 10px">  * @param int $post_ID Post ID.

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

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

<span class="cx" style="display: block; padding: 0 10px">  * @param string $title Title of post.

<span class="cx" style="display: block; padding: 0 10px">  * @param string $excerpt Excerpt of post.

<span class="cx" style="display: block; padding: 0 10px">  * @param int $ID Post ID.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return mixed Database query from update.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return int|false|void Database query from update.

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

</span><span class="cx" style="display: block; padding: 0 10px"> function trackback($trackback_url, $title, $excerpt, $ID) {

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

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

<span class="cx" style="display: block; padding: 0 10px">  * Send a pingback.

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

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

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @uses $wp_version

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

</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global string $wp_version

+ *

</ins><span class="cx" style="display: block; padding: 0 10px">  * @param string $server Host of blog to connect to.

<span class="cx" style="display: block; padding: 0 10px">  * @param string $path Path to send the ping.

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

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

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

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

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

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param object $posts Post data object.

- * @param object $query Query object.

- * @return object

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param WP_Post  $posts Post data object.

+ * @param WP_Query $query Query object.

+ * @return array

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

</span><span class="cx" style="display: block; padding: 0 10px"> function _close_comments_for_old_posts( $posts, $query ) {

</span><span class="cx" style="display: block; padding: 0 10px">        if ( empty( $posts ) || ! $query->is_singular() || ! get_option( 'close_comments_for_old_posts' ) )

</span></span></pre>

</div>

</div>

</body>

</html>