Changeset 48406

Timestamp:

07/08/2020 11:09:08 AM (7 months ago)

Author:

SergeyBiryukov

Message:

Docs: Improve documentation for have_posts(), have_comments(), and their WP_Query counterparts.

Props stevenlinx.
Fixes #50610.

Location:

trunk/src/wp-includes

Files:

• class-wp-query.php (modified) (2 diffs)
• query.php (modified) (2 diffs)

trunk/src/wp-includes/class-wp-query.php

@@ -3320 +3320 @@
      * @since 1.5.0
      *
-     * @return bool True if posts are available, false if end of loop.
+     * @return bool True if posts are available, false if end of the loop.
      */
     public function have_posts() {
@@ -3406 +3406 @@
      * @since 2.2.0
      *
-     * @return bool True, if more comments. False, if no more posts.
+     * @return bool True if comments are available, false if no more comments.
      */
     public function have_comments() {

trunk/src/wp-includes/query.php

@@ -922 +922 @@
  * @global WP_Query $wp_query WordPress Query object.
  *
- * @return bool
+ * @return bool True if posts are available, false if end of the loop.
  */
 function have_posts() {
@@ -982 +982 @@
  * @global WP_Query $wp_query WordPress Query object.
  *
- * @return bool
+ * @return bool True if comments are available, false if no more comments.
  */
 function have_comments() {