<!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>[53469] trunk/src/wp-includes: Docs: Correct method reference format in some DocBlocks.</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/53469">53469</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/53469","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>2022-06-06 10:49:22 +0000 (Mon, 06 Jun 2022)</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: Correct method reference format in some DocBlocks.

This ensures that the methods are recognized by the WordPress Code Reference parser.

Follow-up to <a href="https://core.trac.wordpress.org/changeset/7994">[7994]</a>, <a href="https://core.trac.wordpress.org/changeset/25567">[25567]</a>, <a href="https://core.trac.wordpress.org/changeset/27156">[27156]</a>, <a href="https://core.trac.wordpress.org/changeset/28887">[28887]</a>, <a href="https://core.trac.wordpress.org/changeset/49672">[49672]</a>, <a href="https://core.trac.wordpress.org/changeset/52226">[52226]</a>.

Props dd32, audrasjb.

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

<h3>Modified Paths</h3>

<ul>

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

<li><a href="#trunksrcwpincludesclasswphttpstreamsphp">trunk/src/wp-includes/class-wp-http-streams.php</a></li>

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

<li><a href="#trunksrcwpincludesclasswpsitequeryphp">trunk/src/wp-includes/class-wp-site-query.php</a></li>

<li><a href="#trunksrcwpincludesclasswptermqueryphp">trunk/src/wp-includes/class-wp-term-query.php</a></li>

<li><a href="#trunksrcwpincludesclasswpuserqueryphp">trunk/src/wp-includes/class-wp-user-query.php</a></li>

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

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

</ul>

</div>

<div id="patch">

<h3>Diff</h3>

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

<pre class="diff"><span>

<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-comment-query.php  2022-06-05 19:43:50 UTC (rev 53468)

+++ trunk/src/wp-includes/class-wp-comment-query.php    2022-06-06 10:49:22 UTC (rev 53469)

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

<span class="cx" style="display: block; padding: 0 10px">         *     @type string|string[] $meta_key                  Meta key or keys to filter by.

<span class="cx" style="display: block; padding: 0 10px">         *     @type string|string[] $meta_value                Meta value or values to filter by.

<span class="cx" style="display: block; padding: 0 10px">         *     @type string          $meta_compare              MySQL operator used for comparing the meta value.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         *                                                      See WP_Meta_Query::__construct for accepted values and default value.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  *                                                      See WP_Meta_Query::__construct() for accepted values and default value.

</ins><span class="cx" style="display: block; padding: 0 10px">          *     @type string          $meta_compare_key          MySQL operator used for comparing the meta key.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         *                                                      See WP_Meta_Query::__construct for accepted values and default value.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  *                                                      See WP_Meta_Query::__construct() for accepted values and default value.

</ins><span class="cx" style="display: block; padding: 0 10px">          *     @type string          $meta_type                 MySQL data type that the meta_value column will be CAST to for comparisons.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         *                                                      See WP_Meta_Query::__construct for accepted values and default value.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  *                                                      See WP_Meta_Query::__construct() for accepted values and default value.

</ins><span class="cx" style="display: block; padding: 0 10px">          *     @type string          $meta_type_key             MySQL data type that the meta_key column will be CAST to for comparisons.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         *                                                      See WP_Meta_Query::__construct for accepted values and default value.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  *                                                      See WP_Meta_Query::__construct() for accepted values and default value.

</ins><span class="cx" style="display: block; padding: 0 10px">          *     @type array           $meta_query                An associative array of WP_Meta_Query arguments.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         *                                                      See WP_Meta_Query::__construct for accepted values.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  *                                                      See WP_Meta_Query::__construct() for accepted values.

</ins><span class="cx" style="display: block; padding: 0 10px">          *     @type int             $number                    Maximum number of comments to retrieve.

<span class="cx" style="display: block; padding: 0 10px">         *                                                      Default empty (no limit).

<span class="cx" style="display: block; padding: 0 10px">         *     @type int             $paged                     When used with `$number`, defines the page of results to return.

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

<a id="trunksrcwpincludesclasswphttpstreamsphp"></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-http-streams.php</h4>

<pre class="diff"><span>

<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-http-streams.php   2022-06-05 19:43:50 UTC (rev 53468)

+++ trunk/src/wp-includes/class-wp-http-streams.php     2022-06-06 10:49:22 UTC (rev 53469)

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

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

<span class="cx" style="display: block; padding: 0 10px">         * Send a HTTP request to a URI using PHP Streams.

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

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * @see WP_Http::request For default options descriptions.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * @see WP_Http::request() For default options descriptions.

</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 class="cx" style="display: block; padding: 0 10px">         * @since 3.7.0 Combined with the fsockopen transport and switched to stream_socket_client().

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

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

<pre class="diff"><span>

<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-query.php  2022-06-05 19:43:50 UTC (rev 53468)

+++ trunk/src/wp-includes/class-wp-query.php    2022-06-06 10:49:22 UTC (rev 53469)

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

<span class="cx" style="display: block; padding: 0 10px">         *     @type string|string[] $meta_key                Meta key or keys to filter by.

<span class="cx" style="display: block; padding: 0 10px">         *     @type string|string[] $meta_value              Meta value or values to filter by.

<span class="cx" style="display: block; padding: 0 10px">         *     @type string          $meta_compare            MySQL operator used for comparing the meta value.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         *                                                    See WP_Meta_Query::__construct for accepted values and default value.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  *                                                    See WP_Meta_Query::__construct() for accepted values and default value.

</ins><span class="cx" style="display: block; padding: 0 10px">          *     @type string          $meta_compare_key        MySQL operator used for comparing the meta key.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         *                                                    See WP_Meta_Query::__construct for accepted values and default value.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  *                                                    See WP_Meta_Query::__construct() for accepted values and default value.

</ins><span class="cx" style="display: block; padding: 0 10px">          *     @type string          $meta_type               MySQL data type that the meta_value column will be CAST to for comparisons.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         *                                                    See WP_Meta_Query::__construct for accepted values and default value.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  *                                                    See WP_Meta_Query::__construct() for accepted values and default value.

</ins><span class="cx" style="display: block; padding: 0 10px">          *     @type string          $meta_type_key           MySQL data type that the meta_key column will be CAST to for comparisons.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         *                                                    See WP_Meta_Query::__construct for accepted values and default value.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  *                                                    See WP_Meta_Query::__construct() for accepted values and default value.

</ins><span class="cx" style="display: block; padding: 0 10px">          *     @type array           $meta_query              An associative array of WP_Meta_Query arguments.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         *                                                    See WP_Meta_Query::__construct for accepted values.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  *                                                    See WP_Meta_Query::__construct() for accepted values.

</ins><span class="cx" style="display: block; padding: 0 10px">          *     @type int             $menu_order              The menu order of the posts.

<span class="cx" style="display: block; padding: 0 10px">         *     @type int             $minute                  Minute of the hour. Default empty. Accepts numbers 0-59.

<span class="cx" style="display: block; padding: 0 10px">         *     @type int             $monthnum                The two-digit month. Default empty. Accepts numbers 1-12.

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

</span><span class="cx" style="display: block; padding: 0 10px">         *     @type string[]        $tag_slug__in            An array of tag slugs (OR in). unless 'ignore_sticky_posts' is

<span class="cx" style="display: block; padding: 0 10px">         *                                                    true. Note: a string of comma-separated IDs will NOT work.

<span class="cx" style="display: block; padding: 0 10px">         *     @type array           $tax_query               An associative array of WP_Tax_Query arguments.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         *                                                    See WP_Tax_Query->__construct().

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  *                                                    See WP_Tax_Query::__construct().

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

<span class="cx" style="display: block; padding: 0 10px">         *     @type bool            $update_post_meta_cache  Whether to update the post meta cache. Default true.

<span class="cx" style="display: block; padding: 0 10px">         *     @type bool            $update_post_term_cache  Whether to update the post term cache. Default true.

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

<a id="trunksrcwpincludesclasswpsitequeryphp"></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-site-query.php</h4>

<pre class="diff"><span>

<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-site-query.php     2022-06-05 19:43:50 UTC (rev 53468)

+++ trunk/src/wp-includes/class-wp-site-query.php       2022-06-06 10:49:22 UTC (rev 53469)

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

<span class="cx" style="display: block; padding: 0 10px">         *     @type string|string[] $meta_key               Meta key or keys to filter by.

<span class="cx" style="display: block; padding: 0 10px">         *     @type string|string[] $meta_value             Meta value or values to filter by.

<span class="cx" style="display: block; padding: 0 10px">         *     @type string          $meta_compare           MySQL operator used for comparing the meta value.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         *                                                   See WP_Meta_Query::__construct for accepted values and default value.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  *                                                   See WP_Meta_Query::__construct() for accepted values and default value.

</ins><span class="cx" style="display: block; padding: 0 10px">          *     @type string          $meta_compare_key       MySQL operator used for comparing the meta key.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         *                                                   See WP_Meta_Query::__construct for accepted values and default value.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  *                                                   See WP_Meta_Query::__construct() for accepted values and default value.

</ins><span class="cx" style="display: block; padding: 0 10px">          *     @type string          $meta_type              MySQL data type that the meta_value column will be CAST to for comparisons.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         *                                                   See WP_Meta_Query::__construct for accepted values and default value.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  *                                                   See WP_Meta_Query::__construct() for accepted values and default value.

</ins><span class="cx" style="display: block; padding: 0 10px">          *     @type string          $meta_type_key          MySQL data type that the meta_key column will be CAST to for comparisons.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         *                                                   See WP_Meta_Query::__construct for accepted values and default value.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  *                                                   See WP_Meta_Query::__construct() for accepted values and default value.

</ins><span class="cx" style="display: block; padding: 0 10px">          *     @type array           $meta_query             An associative array of WP_Meta_Query arguments.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         *                                                   See WP_Meta_Query::__construct for accepted values.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  *                                                   See WP_Meta_Query::__construct() for accepted values.

</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">        public function __construct( $query = '' ) {

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

<a id="trunksrcwpincludesclasswptermqueryphp"></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-term-query.php</h4>

<pre class="diff"><span>

<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-term-query.php     2022-06-05 19:43:50 UTC (rev 53468)

+++ trunk/src/wp-includes/class-wp-term-query.php       2022-06-06 10:49:22 UTC (rev 53469)

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