<!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>[49700] trunk/src/wp-includes/class-wp-query.php: Docs: Corrections and improvements to docs for properties of the `WP_Query` class.</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/49700">49700</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/49700","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-11-26 17:02:02 +0000 (Thu, 26 Nov 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: Corrections and improvements to docs for properties of the `WP_Query` class.
This also adds additional type hinting inside some methods to help IDEs.
See <a href="https://core.trac.wordpress.org/ticket/51800">#51800</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpqueryphp">trunk/src/wp-includes/class-wp-query.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<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 2020-11-26 12:32:35 UTC (rev 49699)
+++ trunk/src/wp-includes/class-wp-query.php 2020-11-26 17:02:02 UTC (rev 49700)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -76,7 +76,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public $queried_object_id;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Get post database query.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * SQL for the database query.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.0.1
</span><span class="cx" style="display: block; padding: 0 10px"> * @var string
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -84,10 +84,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public $request;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * List of posts.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Array of post objects or post IDs.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.5.0
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @var array
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @var WP_Post[]|int[]
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public $posts;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -118,8 +118,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * The current post.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * This property does not get populated when the `fields` argument is set to
+ * `ids` or `id=>parent`.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 1.5.0
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @var WP_Post
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @var WP_Post|null
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public $post;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -127,7 +130,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * The list of comments for current post.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.2.0
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @var array
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @var WP_Comment[]
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public $comments;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -148,10 +151,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public $current_comment = -1;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Current comment ID.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Current comment object.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.2.0
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @var int
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @var WP_Comment
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public $comment;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2660,6 +2663,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $comments = (array) $wpdb->get_results( "SELECT $distinct {$wpdb->comments}.* FROM {$wpdb->comments} $cjoin $cwhere $cgroupby $corderby $climits" );
</span><span class="cx" style="display: block; padding: 0 10px"> // Convert to WP_Comment.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /** @var WP_Comment[] */
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->comments = array_map( 'get_comment', $comments );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->comment_count = count( $this->comments );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2944,9 +2948,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.6.0
</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 array|null $posts Return an array of post data to short-circuit WP's query,
- * or null to allow WP to run its normal queries.
- * @param WP_Query $this The WP_Query instance (passed by reference).
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param WP_Post[]|int[]|null $posts Return an array of post data to short-circuit WP's query,
+ * or null to allow WP to run its normal queries.
+ * @param WP_Query $this The WP_Query instance (passed by reference).
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $this->posts = apply_filters_ref_array( 'posts_pre_query', array( null, &$this ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2955,6 +2959,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->posts = $wpdb->get_col( $this->request );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /** @var int[] */
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->posts = array_map( 'intval', $this->posts );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->post_count = count( $this->posts );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->set_found_posts( $q, $limits );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2970,6 +2975,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->post_count = count( $this->posts );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->set_found_posts( $q, $limits );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /** @var int[] */
</ins><span class="cx" style="display: block; padding: 0 10px"> $r = array();
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $this->posts as $key => $post ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->posts[ $key ]->ID = (int) $post->ID;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3030,6 +3036,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Convert to WP_Post objects.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $this->posts ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /** @var WP_Post[] */
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->posts = array_map( 'get_post', $this->posts );
</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">@@ -3066,6 +3073,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $comments_request = "SELECT {$wpdb->comments}.* FROM {$wpdb->comments} $cjoin $cwhere $cgroupby $corderby $climits";
</span><span class="cx" style="display: block; padding: 0 10px"> $comments = $wpdb->get_results( $comments_request );
</span><span class="cx" style="display: block; padding: 0 10px"> // Convert to WP_Comment.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /** @var WP_Comment[] */
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->comments = array_map( 'get_comment', $comments );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->comment_count = count( $this->comments );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3195,6 +3203,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $this->posts ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->post_count = count( $this->posts );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /** @var WP_Post[] */
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->posts = array_map( 'get_post', $this->posts );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $q['cache_results'] ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3201,6 +3210,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> update_post_caches( $this->posts, $post_type, $q['update_post_term_cache'], $q['update_post_meta_cache'] );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /** @var WP_Post */
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->post = reset( $this->posts );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->post_count = 0;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3281,6 +3291,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->current_post++;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /** @var WP_Post */
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->post = $this->posts[ $this->current_post ];
</span><span class="cx" style="display: block; padding: 0 10px"> return $this->post;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3374,6 +3385,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public function next_comment() {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->current_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">+ /** @var WP_Comment */
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->comment = $this->comments[ $this->current_comment ];
</span><span class="cx" style="display: block; padding: 0 10px"> return $this->comment;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>