Make WordPress Core

Changeset 34337


Ignore:
Timestamp:
09/20/2015 12:04:48 AM (9 years ago)
Author:
DrewAPicture
Message:

Docs: Add descriptions for $wp_query global phpDoc references in wp-includes/query.php, partially documented in [32620].

Fixes #32139.

File:
1 edited

Legend:

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

    r34287 r34337  
    1818 * @since 3.9.0 The `$default` argument was introduced.
    1919 *
    20  * @global WP_Query $wp_query
     20 * @global WP_Query $wp_query Global WP_Query instance.
    2121 *
    2222 * @param string $var       The variable key to retrieve.
     
    8585 * @since 1.5.0
    8686 *
    87  * @global WP_Query $wp_query
     87 * @global WP_Query $wp_query Global WP_Query instance.
    8888 *
    8989 * @param string $query
     
    104104 * @since 2.3.0
    105105 *
    106  * @global WP_Query $wp_query
    107  * @global WP_Query $wp_the_query
     106 * @global WP_Query $wp_query     Global WP_Query instance.
     107 * @global WP_Query $wp_the_query Copy of the global WP_Query instance created during wp_reset_query().
    108108 */
    109109function wp_reset_query() {
     
    118118 * @since 3.0.0
    119119 *
    120  * @global WP_Query $wp_query
     120 * @global WP_Query $wp_query Global WP_Query instance.
    121121 */
    122122function wp_reset_postdata() {
     
    139139 * @since 1.5.0
    140140 *
    141  * @global WP_Query $wp_query
     141 * @global WP_Query $wp_query Global WP_Query instance.
    142142 *
    143143 * @return bool
     
    159159 * @since 3.1.0
    160160 *
    161  * @global WP_Query $wp_query
     161 * @global WP_Query $wp_query Global WP_Query instance.
    162162 *
    163163 * @param string|array $post_types Optional. Post type or array of posts types to check against.
     
    180180 * @since 2.0.0
    181181 *
    182  * @global WP_Query $wp_query
     182 * @global WP_Query $wp_query Global WP_Query instance.
    183183 *
    184184 * @param int|string|array|object $attachment Attachment ID, title, slug, or array of such.
     
    204204 * @since 1.5.0
    205205 *
    206  * @global WP_Query $wp_query
     206 * @global WP_Query $wp_query Global WP_Query instance.
    207207 *
    208208 * @param mixed $author Optional. User ID, nickname, nicename, or array of User IDs, nicknames, and nicenames
     
    228228 * @since 1.5.0
    229229 *
    230  * @global WP_Query $wp_query
     230 * @global WP_Query $wp_query Global WP_Query instance.
    231231 *
    232232 * @param mixed $category Optional. Category ID, name, slug, or array of Category IDs, names, and slugs.
     
    252252 * @since 2.3.0
    253253 *
    254  * @global WP_Query $wp_query
     254 * @global WP_Query $wp_query Global WP_Query instance.
    255255 *
    256256 * @param mixed $tag Optional. Tag ID, name, slug, or array of Tag IDs, names, and slugs.
     
    280280 * @since 2.5.0
    281281 *
    282  * @global WP_Query $wp_query
     282 * @global WP_Query $wp_query Global WP_Query instance.
    283283 *
    284284 * @param string|array     $taxonomy Optional. Taxonomy slug or slugs.
     
    302302 * @since 1.5.0
    303303 *
    304  * @global WP_Query $wp_query
     304 * @global WP_Query $wp_query Global WP_Query instance.
    305305 *
    306306 * @return bool
     
    322322 * @since 1.5.0
    323323 *
    324  * @global WP_Query $wp_query
     324 * @global WP_Query $wp_query Global WP_Query instance.
    325325 *
    326326 * @return bool
     
    342342 * @since 1.5.0
    343343 *
    344  * @global WP_Query $wp_query
     344 * @global WP_Query $wp_query Global WP_Query instance.
    345345 *
    346346 * @return bool
     
    362362 * @since 1.5.0
    363363 *
    364  * @global WP_Query $wp_query
     364 * @global WP_Query $wp_query Global WP_Query instance.
    365365 *
    366366 * @param string|array $feeds Optional feed types to check.
     
    383383 * @since 3.0.0
    384384 *
    385  * @global WP_Query $wp_query
     385 * @global WP_Query $wp_query Global WP_Query instance.
    386386 *
    387387 * @return bool
     
    412412 * @since 2.5.0
    413413 *
    414  * @global WP_Query $wp_query
     414 * @global WP_Query $wp_query Global WP_Query instance.
    415415 *
    416416 * @return bool True, if front of site.
     
    441441 * @since 1.5.0
    442442 *
    443  * @global WP_Query $wp_query
     443 * @global WP_Query $wp_query Global WP_Query instance.
    444444 *
    445445 * @return bool True if blog view homepage.
     
    461461 * @since 1.5.0
    462462 *
    463  * @global WP_Query $wp_query
     463 * @global WP_Query $wp_query Global WP_Query instance.
    464464 *
    465465 * @return bool
     
    487487 * @since 1.5.0
    488488 *
    489  * @global WP_Query $wp_query
     489 * @global WP_Query $wp_query Global WP_Query instance.
    490490 *
    491491 * @param mixed $page Page ID, title, slug, or array of such.
     
    508508 * @since 1.5.0
    509509 *
    510  * @global WP_Query $wp_query
     510 * @global WP_Query $wp_query Global WP_Query instance.
    511511 *
    512512 * @return bool
     
    528528 * @since 2.0.0
    529529 *
    530  * @global WP_Query $wp_query
     530 * @global WP_Query $wp_query Global WP_Query instance.
    531531 *
    532532 * @return bool
     
    548548 * @since 2.1.0
    549549 *
    550  * @global WP_Query $wp_query
     550 * @global WP_Query $wp_query Global WP_Query instance.
    551551 *
    552552 * @return bool
     
    568568 * @since 1.5.0
    569569 *
    570  * @global WP_Query $wp_query
     570 * @global WP_Query $wp_query Global WP_Query instance.
    571571 *
    572572 * @return bool
     
    596596 * @since 1.5.0
    597597 *
    598  * @global WP_Query $wp_query
     598 * @global WP_Query $wp_query Global WP_Query instance.
    599599 *
    600600 * @param mixed $post Post ID, title, slug, or array of such.
     
    623623 * @since 1.5.0
    624624 *
    625  * @global WP_Query $wp_query
     625 * @global WP_Query $wp_query Global WP_Query instance.
    626626 *
    627627 * @param mixed $post_types Optional. Post Type or array of Post Types
     
    644644 * @since 1.5.0
    645645 *
    646  * @global WP_Query $wp_query
     646 * @global WP_Query $wp_query Global WP_Query instance.
    647647 *
    648648 * @return bool
     
    664664 * @since 1.5.0
    665665 *
    666  * @global WP_Query $wp_query
     666 * @global WP_Query $wp_query Global WP_Query instance.
    667667 *
    668668 * @return bool
     
    684684 * @since 1.5.0
    685685 *
    686  * @global WP_Query $wp_query
     686 * @global WP_Query $wp_query Global WP_Query instance.
    687687 *
    688688 * @return bool
     
    704704 * @since 1.5.0
    705705 *
    706  * @global WP_Query $wp_query
     706 * @global WP_Query $wp_query Global WP_Query instance.
    707707 *
    708708 * @return bool
     
    724724 * @since 3.3.0
    725725 *
    726  * @global WP_Query $wp_query
     726 * @global WP_Query $wp_query Global WP_Query instance.
    727727 *
    728728 * @return bool
     
    748748 * @since 1.5.0
    749749 *
    750  * @global WP_Query $wp_query
     750 * @global WP_Query $wp_query Global WP_Query instance.
    751751 *
    752752 * @return bool
     
    762762 * @since 2.0.0
    763763 *
    764  * @global WP_Query $wp_query
     764 * @global WP_Query $wp_query Global WP_Query instance.
    765765 *
    766766 * @return bool True if caller is within loop, false if loop hasn't started or ended.
     
    776776 * @since 1.5.0
    777777 *
    778  * @global WP_Query $wp_query
     778 * @global WP_Query $wp_query Global WP_Query instance.
    779779 */
    780780function rewind_posts() {
     
    788788 * @since 1.5.0
    789789 *
    790  * @global WP_Query $wp_query
     790 * @global WP_Query $wp_query Global WP_Query instance.
    791791 */
    792792function the_post() {
     
    804804 * @since 2.2.0
    805805 *
    806  * @global WP_Query $wp_query
     806 * @global WP_Query $wp_query Global WP_Query instance.
    807807 *
    808808 * @return bool
     
    818818 * @since 2.2.0
    819819 *
    820  * @global WP_Query $wp_query
     820 * @global WP_Query $wp_query Global WP_Query instance.
    821821 *
    822822 * @return object
     
    46014601     * @since 3.3.0
    46024602     *
    4603      * @global WP_Query $wp_query
     4603     * @global WP_Query $wp_query Global WP_Query instance.
    46044604     *
    46054605     * @return bool
     
    47204720 * @since 2.1.0
    47214721 *
    4722  * @global WP_Query $wp_query
     4722 * @global WP_Query $wp_query Global WP_Query instance.
    47234723 * @global wpdb     $wpdb     WordPress database abstraction object.
    47244724 */
     
    47784778 * @since 4.4.0 Added the ability to pass a post ID to `$post`.
    47794779 *
    4780  * @global WP_Query $wp_query
     4780 * @global WP_Query $wp_query Global WP_Query instance.
    47814781 *
    47824782 * @param WP_Post|object|int $post WP_Post instance or Post ID/object.
Note: See TracChangeset for help on using the changeset viewer.