WordPress.org

Make WordPress Core

Changeset 49506


Ignore:
Timestamp:
11/05/2020 09:42:49 AM (9 months 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:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/class-wp-query.php

    r49505 r49506  
    36083608     * Is the query for an existing archive page?
    36093609     *
    3610      * Month, Year, Category, Author, Post Type archive...
     3610     * Archive pages include category, tag, author, date, custom post type,
     3611     * and custom taxonomy based archives.
    36113612     *
    36123613     * @since 3.1.0
     3614     *
     3615     * @see WP_Query::is_category()
     3616     * @see WP_Query::is_tag()
     3617     * @see WP_Query::is_author()
     3618     * @see WP_Query::is_date()
     3619     * @see WP_Query::is_post_type_archive()
     3620     * @see WP_Query::is_tax()
    36133621     *
    36143622     * @return bool Whether the query is for an existing archive page.
  • trunk/src/wp-includes/query.php

    r49505 r49506  
    139139 * Determines whether the query is for an existing archive page.
    140140 *
    141  * 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.
    142  *
    143  * For more information on this and similar theme functions, check out
    144  * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
    145  * Conditional Tags} article in the Theme Developer Handbook.
    146  *
    147  * @since 1.5.0
    148  *
     141 * Archive pages include category, tag, author, date, custom post type,
     142 * and custom taxonomy based archives.
     143 *
     144 * For more information on this and similar theme functions, check out
     145 * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
     146 * Conditional Tags} article in the Theme Developer Handbook.
     147 *
     148 * @since 1.5.0
     149 *
     150 * @see is_category()
     151 * @see is_tag()
     152 * @see is_author()
     153 * @see is_date()
     154 * @see is_post_type_archive()
     155 * @see is_tax()
    149156 * @global WP_Query $wp_query WordPress Query object.
    150157 *
Note: See TracChangeset for help on using the changeset viewer.