<!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>[48941] trunk/src: Docs: Various docblock corrections and improvements.</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/48941">48941</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/48941","name":"Review Commit"}}</script></dd>

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

<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-09-04 20:39:47 +0000 (Fri, 04 Sep 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: Various docblock corrections and improvements.

See <a href="https://core.trac.wordpress.org/ticket/50768">#50768</a></pre>

<h3>Modified Paths</h3>

<ul>

<li><a href="#trunksrcwpadminincludesclasswpcommentslisttablephp">trunk/src/wp-admin/includes/class-wp-comments-list-table.php</a></li>

<li><a href="#trunksrcwpadminmediauploadphp">trunk/src/wp-admin/media-upload.php</a></li>

<li><a href="#trunksrcwpincludescategorytemplatephp">trunk/src/wp-includes/category-template.php</a></li>

<li><a href="#trunksrcwpincludesclasswpcommentphp">trunk/src/wp-includes/class-wp-comment.php</a></li>

<li><a href="#trunksrcwpincludesclasswppostphp">trunk/src/wp-includes/class-wp-post.php</a></li>

<li><a href="#trunksrcwpincludesloadphp">trunk/src/wp-includes/load.php</a></li>

<li><a href="#trunksrcwpincludespostphp">trunk/src/wp-includes/post.php</a></li>

<li><a href="#trunksrcwpincludestaxonomyphp">trunk/src/wp-includes/taxonomy.php</a></li>

</ul>

</div>

<div id="patch">

<h3>Diff</h3>

<a id="trunksrcwpadminincludesclasswpcommentslisttablephp"></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/class-wp-comments-list-table.php</h4>

<pre class="diff"><span>

<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/class-wp-comments-list-table.php      2020-09-04 07:36:33 UTC (rev 48940)

+++ trunk/src/wp-admin/includes/class-wp-comments-list-table.php        2020-09-04 20:39:47 UTC (rev 48941)

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

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

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * Displays a comment status drop-down for filtering on the Comments list table.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * Displays a comment type drop-down for filtering on the Comments list table.

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

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

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

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

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

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

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

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                 * Filters the comment types dropdown menu.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+          * Filters the comment types shown in the drop-down menu on the Comments list table.

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

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                 * @param array $comment_types An array of comment types. Accepts 'Comments', 'Pings'.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+          * @param string[] $comment_types Array of comment type labels keyed by their name.

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

</span><span class="cx" style="display: block; padding: 0 10px">                $comment_types = apply_filters(

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

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

<a id="trunksrcwpadminmediauploadphp"></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/media-upload.php</h4>

<pre class="diff"><span>

<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/media-upload.php       2020-09-04 07:36:33 UTC (rev 48940)

+++ trunk/src/wp-admin/media-upload.php 2020-09-04 20:39:47 UTC (rev 48941)

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

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

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * @param string $type The default media popup tab. Default 'type' (From Computer).

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * @param string $tab The default media popup tab. Default 'type' (From Computer).

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

</span><span class="cx" style="display: block; padding: 0 10px">        $tab = apply_filters( 'media_upload_default_tab', 'type' );

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

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

<a id="trunksrcwpincludescategorytemplatephp"></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/category-template.php</h4>

<pre class="diff"><span>

<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/category-template.php       2020-09-04 07:36:33 UTC (rev 48940)

+++ trunk/src/wp-includes/category-template.php 2020-09-04 20:39:47 UTC (rev 48941)

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

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

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

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

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return array|false|WP_Error Array of tag objects on success, false on failure.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return WP_Term[]|false|WP_Error Array of WP_Term objects on success, false if there are no terms

+ *                                  or the post does not exist, WP_Error on failure.

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

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

</span><span class="cx" style="display: block; padding: 0 10px">        $terms = get_the_terms( $post_id, 'post_tag' );

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

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

</span><span class="cx" style="display: block; padding: 0 10px">         * @see get_the_terms()

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

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * @param WP_Term[] $terms An array of tags for the given post.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * @param WP_Term[]|false|WP_Error $terms Array of WP_Term objects on success, false if there are no terms

+        *                                        or the post does not exist, WP_Error on failure.

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

</span><span class="cx" style="display: block; padding: 0 10px">        return apply_filters( 'get_the_tags', $terms );

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

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

<a id="trunksrcwpincludesclasswpcommentphp"></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-comment.php</h4>

<pre class="diff"><span>

<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-comment.php        2020-09-04 07:36:33 UTC (rev 48940)

+++ trunk/src/wp-includes/class-wp-comment.php  2020-09-04 20:39:47 UTC (rev 48941)

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

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

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

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