Changeset 40966

Timestamp:

06/30/2017 03:43:41 AM (9 years ago)

Author:

DrewAPicture

Message:

Docs: Add more useful summaries to the DocBlocks for boolean $is_* properties in WP_Query.

Props megane9988 for the initial patch.
Fixes #34726.

File:

• trunk/src/wp-includes/class-wp-query.php (modified) (27 diffs)

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

@@ -203 +203 @@
 
         /**
-         * Set if query is single post.
+         * Signifies whether the current query is for a single post.
          *
          * @since 1.5.0
@@ -212 +212 @@
 
         /**
-         * Set if query is preview of blog.
+         * Signifies whether the current query is for a preview.
          *
          * @since 2.0.0
@@ -221 +221 @@
 
         /**
-         * Set if query returns a page.
+         * Signifies whether the current query is for a page.
          *
          * @since 1.5.0
@@ -230 +230 @@
 
         /**
-         * Set if query is an archive list.
+         * Signifies whether the current query is for an archive.
          *
          * @since 1.5.0
@@ -239 +239 @@
 
         /**
-         * Set if query is part of a date.
+         * Signifies whether the current query is for a date archive.
          *
          * @since 1.5.0
@@ -248 +248 @@
 
         /**
-         * Set if query contains a year.
+         * Signifies whether the current query is for a year archive.
          *
          * @since 1.5.0
@@ -257 +257 @@
 
         /**
-         * Set if query contains a month.
+         * Signifies whether the current query is for a month archive.
          *
          * @since 1.5.0
@@ -266 +266 @@
 
         /**
-         * Set if query contains a day.
+         * Signifies whether the current query is for a day archive.
          *
          * @since 1.5.0
@@ -275 +275 @@
 
         /**
-         * Set if query contains time.
+         * Signifies whether the current query is for a specific time.
          *
          * @since 1.5.0
@@ -284 +284 @@
 
         /**
-         * Set if query contains an author.
+         * Signifies whether the current query is for an author archive.
          *
          * @since 1.5.0
@@ -293 +293 @@
 
         /**
-         * Set if query contains category.
+         * Signifies whether the current query is for a category archive.
          *
          * @since 1.5.0
@@ -302 +302 @@
 
         /**
-         * Set if query contains tag.
+         * Signifies whether the current query is for a tag archive.
          *
          * @since 2.3.0
@@ -311 +311 @@
 
         /**
-         * Set if query contains taxonomy.
+         * Signifies whether the current query is for a taxonomy archive.
          *
          * @since 2.5.0
@@ -320 +320 @@
 
         /**
-         * Set if query was part of a search result.
+         * Signifies whether the current query is for a search.
          *
          * @since 1.5.0
@@ -329 +329 @@
 
         /**
-         * Set if query is feed display.
+         * Signifies whether the current query is for a feed.
          *
          * @since 1.5.0
@@ -338 +338 @@
 
         /**
-         * Set if query is comment feed display.
+         * Signifies whether the current query is for a comment feed.
          *
          * @since 2.2.0
@@ -347 +347 @@
 
         /**
-         * Set if query is trackback.
+         * Signifies whether the current query is for trackback endpoint call.
          *
          * @since 1.5.0
@@ -356 +356 @@
 
         /**
-         * Set if query is blog homepage.
+         * Signifies whether the current query is for the site homepage.
          *
          * @since 1.5.0
@@ -365 +365 @@
 
         /**
-         * Set if query couldn't found anything.
+         * Signifies whether the current query couldn't find anything.
          *
          * @since 1.5.0
@@ -374 +374 @@
 
         /**
-         * Set if query is embed.
+         * Signifies whether the current query is for an embed.
          *
          * @since 4.4.0
@@ -383 +383 @@
 
         /**
-         * Set if query is paged
+         * Signifies whether the current query is for a paged result and not for the first page.
          *
          * @since 1.5.0
@@ -392 +392 @@
 
         /**
-         * Set if query is part of administration page.
+         * Signifies whether the current query is for an administrative interface page.
          *
          * @since 1.5.0
@@ -401 +401 @@
 
         /**
-         * Set if query is an attachment.
+         * Signifies whether the current query is for an attachment page.
          *
          * @since 2.0.0
@@ -410 +410 @@
 
         /**
-         * Set if is single, is a page, or is an attachment.
+         * Signifies whether the current query is for an existing single post of any post type
+         * (post, attachment, page, custom post types).
          *
          * @since 2.1.0
@@ -419 +420 @@
 
         /**
-         * Set if query is for robots.
+         * Signifies whether the current query is for the robots.txt file.
          *
          * @since 2.1.0
@@ -428 +429 @@
 
         /**
-         * Set if query contains posts.
+         * Signifies whether the current query is for the page_for_posts page.
          *
          * Basically, the homepage if the option isn't set for the static homepage.
@@ -439 +440 @@
 
         /**
-         * Set if query is for a post type archive.
+         * Signifies whether the current query is for a post type archive.
          *
          * @since 3.1.0