Changeset 49506

Timestamp:

11/05/2020 09:42:49 AM (3 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve documentation for WP_Query::is_archive() per the documentation standards.

Follow-up to [49504].

See #50545.

Location:

trunk/src/wp-includes

Files:

• class-wp-query.php (modified) (1 diff)
• query.php (modified) (1 diff)

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

@@ -3608 +3608 @@
      * Is the query for an existing archive page?
      *
-     * Month, Year, Category, Author, Post Type archive...
+     * Archive pages include category, tag, author, date, custom post type,
+     * and custom taxonomy based archives.
      *
      * @since 3.1.0
+     *
+     * @see WP_Query::is_category()
+     * @see WP_Query::is_tag()
+     * @see WP_Query::is_author()
+     * @see WP_Query::is_date()
+     * @see WP_Query::is_post_type_archive()
+     * @see WP_Query::is_tax()
      *
      * @return bool Whether the query is for an existing archive page.

trunk/src/wp-includes/query.php

@@ -139 +139 @@
  * Determines whether the query is for an existing archive page.
  *
- * Archive pages include {@link https://developer.wordpress.org/reference/functions/is_category/ category}, {@link https://developer.wordpress.org/reference/functions/is_tag/ tag}, {@link https://developer.wordpress.org/reference/functions/is_author/ author}, {@link https://developer.wordpress.org/reference/functions/is_date/ date}, {@link https://developer.wordpress.org/reference/functions/is_post_type_archive/ custom post type}, and {@link https://developer.wordpress.org/reference/functions/is_tax/ custom taxonomy} based archives.
- *
- * For more information on this and similar theme functions, check out
- * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
- * Conditional Tags} article in the Theme Developer Handbook.
- *
- * @since 1.5.0
- *
+ * Archive pages include category, tag, author, date, custom post type,
+ * and custom taxonomy based archives.
+ *
+ * For more information on this and similar theme functions, check out
+ * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
+ * Conditional Tags} article in the Theme Developer Handbook.
+ *
+ * @since 1.5.0
+ *
+ * @see is_category()
+ * @see is_tag()
+ * @see is_author()
+ * @see is_date()
+ * @see is_post_type_archive()
+ * @see is_tax()
  * @global WP_Query $wp_query WordPress Query object.
  *