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

Follow-up to [49504].

See #50545.
Built from https://develop.svn.wordpress.org/trunk@49506


git-svn-id: http://core.svn.wordpress.org/trunk@49261 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov 2020-11-05 09:44:05 +00:00
parent f22633f20b
commit ee7ff18b54
3 changed files with 18 additions and 3 deletions

View File

@ -3607,10 +3607,18 @@ class WP_Query {
/** /**
* Is the query for an existing archive page? * 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 * @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. * @return bool Whether the query is for an existing archive page.
*/ */
public function is_archive() { public function is_archive() {

View File

@ -138,7 +138,8 @@ function wp_reset_postdata() {
/** /**
* Determines whether the query is for an existing archive page. * 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. * 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 * For more information on this and similar theme functions, check out
* the {@link https://developer.wordpress.org/themes/basics/conditional-tags/ * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
@ -146,6 +147,12 @@ function wp_reset_postdata() {
* *
* @since 1.5.0 * @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. * @global WP_Query $wp_query WordPress Query object.
* *
* @return bool Whether the query is for an existing archive page. * @return bool Whether the query is for an existing archive page.

View File

@ -13,7 +13,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '5.6-beta3-49505'; $wp_version = '5.6-beta3-49506';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.