WordPress.org

Make WordPress Core

Changeset 40966


Ignore:
Timestamp:
06/30/2017 03:43:41 AM (3 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:
1 edited

Legend:

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

    r40923 r40966  
    203203
    204204    /**
    205      * Set if query is single post.
     205     * Signifies whether the current query is for a single post.
    206206     *
    207207     * @since 1.5.0
     
    212212
    213213    /**
    214      * Set if query is preview of blog.
     214     * Signifies whether the current query is for a preview.
    215215     *
    216216     * @since 2.0.0
     
    221221
    222222    /**
    223      * Set if query returns a page.
     223     * Signifies whether the current query is for a page.
    224224     *
    225225     * @since 1.5.0
     
    230230
    231231    /**
    232      * Set if query is an archive list.
     232     * Signifies whether the current query is for an archive.
    233233     *
    234234     * @since 1.5.0
     
    239239
    240240    /**
    241      * Set if query is part of a date.
     241     * Signifies whether the current query is for a date archive.
    242242     *
    243243     * @since 1.5.0
     
    248248
    249249    /**
    250      * Set if query contains a year.
     250     * Signifies whether the current query is for a year archive.
    251251     *
    252252     * @since 1.5.0
     
    257257
    258258    /**
    259      * Set if query contains a month.
     259     * Signifies whether the current query is for a month archive.
    260260     *
    261261     * @since 1.5.0
     
    266266
    267267    /**
    268      * Set if query contains a day.
     268     * Signifies whether the current query is for a day archive.
    269269     *
    270270     * @since 1.5.0
     
    275275
    276276    /**
    277      * Set if query contains time.
     277     * Signifies whether the current query is for a specific time.
    278278     *
    279279     * @since 1.5.0
     
    284284
    285285    /**
    286      * Set if query contains an author.
     286     * Signifies whether the current query is for an author archive.
    287287     *
    288288     * @since 1.5.0
     
    293293
    294294    /**
    295      * Set if query contains category.
     295     * Signifies whether the current query is for a category archive.
    296296     *
    297297     * @since 1.5.0
     
    302302
    303303    /**
    304      * Set if query contains tag.
     304     * Signifies whether the current query is for a tag archive.
    305305     *
    306306     * @since 2.3.0
     
    311311
    312312    /**
    313      * Set if query contains taxonomy.
     313     * Signifies whether the current query is for a taxonomy archive.
    314314     *
    315315     * @since 2.5.0
     
    320320
    321321    /**
    322      * Set if query was part of a search result.
     322     * Signifies whether the current query is for a search.
    323323     *
    324324     * @since 1.5.0
     
    329329
    330330    /**
    331      * Set if query is feed display.
     331     * Signifies whether the current query is for a feed.
    332332     *
    333333     * @since 1.5.0
     
    338338
    339339    /**
    340      * Set if query is comment feed display.
     340     * Signifies whether the current query is for a comment feed.
    341341     *
    342342     * @since 2.2.0
     
    347347
    348348    /**
    349      * Set if query is trackback.
     349     * Signifies whether the current query is for trackback endpoint call.
    350350     *
    351351     * @since 1.5.0
     
    356356
    357357    /**
    358      * Set if query is blog homepage.
     358     * Signifies whether the current query is for the site homepage.
    359359     *
    360360     * @since 1.5.0
     
    365365
    366366    /**
    367      * Set if query couldn't found anything.
     367     * Signifies whether the current query couldn't find anything.
    368368     *
    369369     * @since 1.5.0
     
    374374
    375375    /**
    376      * Set if query is embed.
     376     * Signifies whether the current query is for an embed.
    377377     *
    378378     * @since 4.4.0
     
    383383
    384384    /**
    385      * Set if query is paged
     385     * Signifies whether the current query is for a paged result and not for the first page.
    386386     *
    387387     * @since 1.5.0
     
    392392
    393393    /**
    394      * Set if query is part of administration page.
     394     * Signifies whether the current query is for an administrative interface page.
    395395     *
    396396     * @since 1.5.0
     
    401401
    402402    /**
    403      * Set if query is an attachment.
     403     * Signifies whether the current query is for an attachment page.
    404404     *
    405405     * @since 2.0.0
     
    410410
    411411    /**
    412      * Set if is single, is a page, or is an attachment.
     412     * Signifies whether the current query is for an existing single post of any post type
     413     * (post, attachment, page, custom post types).
    413414     *
    414415     * @since 2.1.0
     
    419420
    420421    /**
    421      * Set if query is for robots.
     422     * Signifies whether the current query is for the robots.txt file.
    422423     *
    423424     * @since 2.1.0
     
    428429
    429430    /**
    430      * Set if query contains posts.
     431     * Signifies whether the current query is for the page_for_posts page.
    431432     *
    432433     * Basically, the homepage if the option isn't set for the static homepage.
     
    439440
    440441    /**
    441      * Set if query is for a post type archive.
     442     * Signifies whether the current query is for a post type archive.
    442443     *
    443444     * @since 3.1.0
Note: See TracChangeset for help on using the changeset viewer.