From d19f4d7ff4695b1cec812000c14fba18aaa4864b Mon Sep 17 00:00:00 2001 From: Sergey Biryukov Date: Sun, 4 Aug 2019 01:58:03 +0000 Subject: [PATCH] Docs: Add missing description for `$wp_query` and `$wp_the_query` globals. Props mukesh27. See #45604, #47110. git-svn-id: https://develop.svn.wordpress.org/trunk@45739 602fd350-edb4-49c9-b593-d223f7449a82 --- .../includes/class-wp-media-list-table.php | 2 +- .../includes/class-wp-posts-list-table.php | 4 +- src/wp-admin/includes/export.php | 2 +- src/wp-admin/includes/media.php | 4 +- src/wp-includes/admin-bar.php | 2 +- src/wp-includes/canonical.php | 8 +- src/wp-includes/class-wp-query.php | 2 +- src/wp-includes/class-wp.php | 18 ++-- src/wp-includes/comment-template.php | 4 +- src/wp-includes/comment.php | 2 +- src/wp-includes/feed.php | 4 +- src/wp-includes/functions.php | 8 +- src/wp-includes/general-template.php | 2 +- src/wp-includes/link-template.php | 6 +- src/wp-includes/nav-menu-template.php | 2 +- src/wp-includes/post-template.php | 4 +- src/wp-includes/post-thumbnail-template.php | 2 +- src/wp-includes/query.php | 86 +++++++++---------- src/wp-includes/template.php | 2 +- src/wp-settings.php | 4 +- 20 files changed, 84 insertions(+), 84 deletions(-) diff --git a/src/wp-admin/includes/class-wp-media-list-table.php b/src/wp-admin/includes/class-wp-media-list-table.php index 6692324522..ab1300040f 100644 --- a/src/wp-admin/includes/class-wp-media-list-table.php +++ b/src/wp-admin/includes/class-wp-media-list-table.php @@ -61,7 +61,7 @@ class WP_Media_List_Table extends WP_List_Table { } /** - * @global WP_Query $wp_query + * @global WP_Query $wp_query WordPress Query object. * @global array $post_mime_types * @global array $avail_post_mime_types * @global string $mode diff --git a/src/wp-admin/includes/class-wp-posts-list-table.php b/src/wp-admin/includes/class-wp-posts-list-table.php index 6d9237c7b5..d528d7a3ad 100644 --- a/src/wp-admin/includes/class-wp-posts-list-table.php +++ b/src/wp-admin/includes/class-wp-posts-list-table.php @@ -136,7 +136,7 @@ class WP_Posts_List_Table extends WP_List_Table { /** * @global array $avail_post_stati - * @global WP_Query $wp_query + * @global WP_Query $wp_query WordPress Query object. * @global int $per_page * @global string $mode */ @@ -695,7 +695,7 @@ class WP_Posts_List_Table extends WP_List_Table { } /** - * @global WP_Query $wp_query + * @global WP_Query $wp_query WordPress Query object. * @global int $per_page * @param array $posts * @param int $level diff --git a/src/wp-admin/includes/export.php b/src/wp-admin/includes/export.php index 54e0af0346..8485ef80a4 100644 --- a/src/wp-admin/includes/export.php +++ b/src/wp-admin/includes/export.php @@ -525,7 +525,7 @@ function export_wp( $args = array() ) { comments * - * @global WP_Query $wp_query + * @global WP_Query $wp_query WordPress Query object. * @global int $comment_alt * @global int $comment_depth * @global int $comment_thread_alt diff --git a/src/wp-includes/comment.php b/src/wp-includes/comment.php index a469b90c57..1ae94451d8 100644 --- a/src/wp-includes/comment.php +++ b/src/wp-includes/comment.php @@ -964,7 +964,7 @@ function separate_comments( &$comments ) { * * @uses Walker_Comment * - * @global WP_Query $wp_query + * @global WP_Query $wp_query WordPress Query object. * * @param WP_Comment[] $comments Optional. Array of WP_Comment objects. Defaults to $wp_query->comments. * @param int $per_page Optional. Comments per page. diff --git a/src/wp-includes/feed.php b/src/wp-includes/feed.php index bd0c06fc25..d01fba7c8b 100644 --- a/src/wp-includes/feed.php +++ b/src/wp-includes/feed.php @@ -637,13 +637,13 @@ function self_link() { echo esc_url( apply_filters( 'self_link', set_url_scheme( 'http://' . $host['host'] . wp_unslash( $_SERVER['REQUEST_URI'] ) ) ) ); } -/* +/** * Get the timestamp of the most recently modified post from WP_Query. * * If viewing a comment feed, the timestamp of the most recently modified * comment will be returned. * - * @global WP_Query $wp_query The global WP_Query object. + * @global WP_Query $wp_query WordPress Query object. * * @since 5.2.0 * diff --git a/src/wp-includes/functions.php b/src/wp-includes/functions.php index 0074b240d1..3171d4fbca 100644 --- a/src/wp-includes/functions.php +++ b/src/wp-includes/functions.php @@ -1113,8 +1113,8 @@ function wp_remote_fopen( $uri ) { * @since 2.0.0 * * @global WP $wp Current WordPress environment instance. - * @global WP_Query $wp_query - * @global WP_Query $wp_the_query + * @global WP_Query $wp_query WordPress Query object. + * @global WP_Query $wp_the_query Copy of the WordPress Query object. * * @param string|array $query_vars Default WP_Query arguments. */ @@ -1378,7 +1378,7 @@ function bool_from_yn( $yn ) { * * @since 2.1.0 * - * @global WP_Query $wp_query Used to tell if the use a comment feed. + * @global WP_Query $wp_query WordPress Query object. */ function do_feed() { global $wp_query; @@ -2966,7 +2966,7 @@ function wp_nonce_ays( $action ) { * an integer to be used as the response code. * @since 5.1.0 The `$link_url`, `$link_text`, and `$exit` arguments were added. * - * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_query WordPress Query object. * * @param string|WP_Error $message Optional. Error message. If this is a WP_Error object, * and not an Ajax or XML-RPC request, the error's messages are used. diff --git a/src/wp-includes/general-template.php b/src/wp-includes/general-template.php index 8816f4706a..96172b6675 100644 --- a/src/wp-includes/general-template.php +++ b/src/wp-includes/general-template.php @@ -3925,7 +3925,7 @@ function language_attributes( $doctype = 'html' ) { * @since 2.1.0 * @since 4.9.0 Added the `aria_current` argument. * - * @global WP_Query $wp_query + * @global WP_Query $wp_query WordPress Query object. * @global WP_Rewrite $wp_rewrite WordPress rewrite component. * * @param string|array $args { diff --git a/src/wp-includes/link-template.php b/src/wp-includes/link-template.php index 15a00a1542..878a111980 100644 --- a/src/wp-includes/link-template.php +++ b/src/wp-includes/link-template.php @@ -2322,7 +2322,7 @@ function next_posts( $max_page = 0, $echo = true ) { * @since 2.7.0 * * @global int $paged - * @global WP_Query $wp_query + * @global WP_Query $wp_query WordPress Query object. * * @param string $label Content for link text. * @param int $max_page Optional. Max pages. Default 0. @@ -2460,7 +2460,7 @@ function previous_posts_link( $label = null ) { * * @since 2.8.0 * - * @global WP_Query $wp_query + * @global WP_Query $wp_query WordPress Query object. * * @param string|array $args { * Optional. Arguments to build the post pages link navigation. @@ -2801,7 +2801,7 @@ function get_comments_pagenum_link( $pagenum = 1, $max_page = 0 ) { * * @since 2.7.1 * - * @global WP_Query $wp_query + * @global WP_Query $wp_query WordPress Query object. * * @param string $label Optional. Label for link text. Default empty. * @param int $max_page Optional. Max page. Default 0. diff --git a/src/wp-includes/nav-menu-template.php b/src/wp-includes/nav-menu-template.php index 3a28b2183a..cbd6fcdef9 100644 --- a/src/wp-includes/nav-menu-template.php +++ b/src/wp-includes/nav-menu-template.php @@ -294,7 +294,7 @@ function wp_nav_menu( $args = array() ) { * @access private * @since 3.0.0 * - * @global WP_Query $wp_query + * @global WP_Query $wp_query WordPress Query object. * @global WP_Rewrite $wp_rewrite WordPress rewrite component. * * @param array $menu_items The current menu item objects to which to add the class property information. diff --git a/src/wp-includes/post-template.php b/src/wp-includes/post-template.php index d5bd048489..96af0b60d1 100644 --- a/src/wp-includes/post-template.php +++ b/src/wp-includes/post-template.php @@ -607,7 +607,7 @@ function body_class( $class = '' ) { * * @since 2.8.0 * - * @global WP_Query $wp_query + * @global WP_Query $wp_query WordPress Query object. * * @param string|string[] $class Space-separated string or array of class names to add to the class list. * @return string[] Array of class names. @@ -1233,7 +1233,7 @@ function wp_dropdown_pages( $args = '' ) { * * @see get_pages() * - * @global WP_Query $wp_query + * @global WP_Query $wp_query WordPress Query object. * * @param array|string $args { * Optional. Array or string of arguments to generate a list of pages. See `get_pages()` for additional arguments. diff --git a/src/wp-includes/post-thumbnail-template.php b/src/wp-includes/post-thumbnail-template.php index 688929fa6a..8202f4eb6a 100644 --- a/src/wp-includes/post-thumbnail-template.php +++ b/src/wp-includes/post-thumbnail-template.php @@ -83,7 +83,7 @@ function the_post_thumbnail( $size = 'post-thumbnail', $attr = '' ) { * * @since 3.2.0 * - * @global WP_Query $wp_query + * @global WP_Query $wp_query WordPress Query object. * * @param WP_Query $wp_query Optional. A WP_Query instance. Defaults to the $wp_query global. */ diff --git a/src/wp-includes/query.php b/src/wp-includes/query.php index 89eede633f..04acffb824 100644 --- a/src/wp-includes/query.php +++ b/src/wp-includes/query.php @@ -17,7 +17,7 @@ * @since 1.5.0 * @since 3.9.0 The `$default` argument was introduced. * - * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_query WordPress Query object. * * @param string $var The variable key to retrieve. * @param mixed $default Optional. Value to return if the query variable is not set. Default empty. @@ -35,7 +35,7 @@ function get_query_var( $var, $default = '' ) { * * @since 3.1.0 * - * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_query WordPress Query object. * * @return object Queried object. */ @@ -51,7 +51,7 @@ function get_queried_object() { * * @since 3.1.0 * - * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_query WordPress Query object. * * @return int ID of the queried object. */ @@ -65,7 +65,7 @@ function get_queried_object_id() { * * @since 2.2.0 * - * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_query WordPress Query object. * * @param string $var Query variable key. * @param mixed $value Query variable value. @@ -88,7 +88,7 @@ function set_query_var( $var, $value ) { * * @since 1.5.0 * - * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_query WordPress Query object. * * @param array|string $query Array or string of WP_Query arguments. * @return array List of post objects. @@ -107,7 +107,7 @@ function query_posts( $query ) { * * @since 2.3.0 * - * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_query WordPress Query object. * @global WP_Query $wp_the_query Copy of the global WP_Query instance created during wp_reset_query(). */ function wp_reset_query() { @@ -121,7 +121,7 @@ function wp_reset_query() { * * @since 3.0.0 * - * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_query WordPress Query object. */ function wp_reset_postdata() { global $wp_query; @@ -146,7 +146,7 @@ function wp_reset_postdata() { * * @since 1.5.0 * - * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_query WordPress Query object. * * @return bool */ @@ -170,7 +170,7 @@ function is_archive() { * * @since 3.1.0 * - * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_query WordPress Query object. * * @param string|array $post_types Optional. Post type or array of posts types to check against. * @return bool @@ -195,7 +195,7 @@ function is_post_type_archive( $post_types = '' ) { * * @since 2.0.0 * - * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_query WordPress Query object. * * @param int|string|array|object $attachment Attachment ID, title, slug, or array of such. * @return bool @@ -223,7 +223,7 @@ function is_attachment( $attachment = '' ) { * * @since 1.5.0 * - * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_query WordPress Query object. * * @param mixed $author Optional. User ID, nickname, nicename, or array of User IDs, nicknames, and nicenames * @return bool @@ -251,7 +251,7 @@ function is_author( $author = '' ) { * * @since 1.5.0 * - * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_query WordPress Query object. * * @param mixed $category Optional. Category ID, name, slug, or array of Category IDs, names, and slugs. * @return bool @@ -279,7 +279,7 @@ function is_category( $category = '' ) { * * @since 2.3.0 * - * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_query WordPress Query object. * * @param mixed $tag Optional. Tag ID, name, slug, or array of Tag IDs, names, and slugs. * @return bool @@ -311,7 +311,7 @@ function is_tag( $tag = '' ) { * * @since 2.5.0 * - * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_query WordPress Query object. * * @param string|array $taxonomy Optional. Taxonomy slug or slugs. * @param int|string|array $term Optional. Term ID, name, slug or array of Term IDs, names, and slugs. @@ -337,7 +337,7 @@ function is_tax( $taxonomy = '', $term = '' ) { * * @since 1.5.0 * - * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_query WordPress Query object. * * @return bool */ @@ -363,7 +363,7 @@ function is_date() { * * @since 1.5.0 * - * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_query WordPress Query object. * * @return bool */ @@ -387,7 +387,7 @@ function is_day() { * * @since 1.5.0 * - * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_query WordPress Query object. * * @param string|array $feeds Optional feed types to check. * @return bool @@ -408,7 +408,7 @@ function is_feed( $feeds = '' ) { * * @since 3.0.0 * - * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_query WordPress Query object. * * @return bool */ @@ -441,7 +441,7 @@ function is_comment_feed() { * * @since 2.5.0 * - * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_query WordPress Query object. * * @return bool True, if front of site. */ @@ -474,7 +474,7 @@ function is_front_page() { * @since 1.5.0 * * @see is_front_page() - * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_query WordPress Query object. * * @return bool True if blog view homepage, otherwise false. */ @@ -504,7 +504,7 @@ function is_home() { * * @since 5.2.0 * - * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_query WordPress Query object. * * @return bool */ @@ -528,7 +528,7 @@ function is_privacy_policy() { * * @since 1.5.0 * - * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_query WordPress Query object. * * @return bool */ @@ -558,7 +558,7 @@ function is_month() { * * @since 1.5.0 * - * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_query WordPress Query object. * * @param int|string|array $page Optional. Page ID, title, slug, or array of such. Default empty. * @return bool Whether the query is for an existing single page. @@ -583,7 +583,7 @@ function is_page( $page = '' ) { * * @since 1.5.0 * - * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_query WordPress Query object. * * @return bool */ @@ -607,7 +607,7 @@ function is_paged() { * * @since 2.0.0 * - * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_query WordPress Query object. * * @return bool */ @@ -627,7 +627,7 @@ function is_preview() { * * @since 2.1.0 * - * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_query WordPress Query object. * * @return bool */ @@ -651,7 +651,7 @@ function is_robots() { * * @since 1.5.0 * - * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_query WordPress Query object. * * @return bool */ @@ -683,7 +683,7 @@ function is_search() { * * @since 1.5.0 * - * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_query WordPress Query object. * * @param int|string|array $post Optional. Post ID, title, slug, or array of such. Default empty. * @return bool Whether the query is for an existing single post. @@ -715,7 +715,7 @@ function is_single( $post = '' ) { * * @since 1.5.0 * - * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_query WordPress Query object. * * @param string|array $post_types Optional. Post type or array of post types. Default empty. * @return bool Whether the query is for an existing single post of any of the given post types. @@ -740,7 +740,7 @@ function is_singular( $post_types = '' ) { * * @since 1.5.0 * - * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_query WordPress Query object. * * @return bool */ @@ -764,7 +764,7 @@ function is_time() { * * @since 1.5.0 * - * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_query WordPress Query object. * * @return bool */ @@ -788,7 +788,7 @@ function is_trackback() { * * @since 1.5.0 * - * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_query WordPress Query object. * * @return bool */ @@ -812,7 +812,7 @@ function is_year() { * * @since 1.5.0 * - * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_query WordPress Query object. * * @return bool */ @@ -832,7 +832,7 @@ function is_404() { * * @since 4.4.0 * - * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_query WordPress Query object. * * @return bool Whether we're in an embedded post or not. */ @@ -856,7 +856,7 @@ function is_embed() { * * @since 3.3.0 * - * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_query WordPress Query object. * * @return bool */ @@ -886,7 +886,7 @@ function is_main_query() { * * @since 1.5.0 * - * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_query WordPress Query object. * * @return bool */ @@ -904,7 +904,7 @@ function have_posts() { * * @since 2.0.0 * - * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_query WordPress Query object. * * @return bool True if caller is within loop, false if loop hasn't started or ended. */ @@ -918,7 +918,7 @@ function in_the_loop() { * * @since 1.5.0 * - * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_query WordPress Query object. */ function rewind_posts() { global $wp_query; @@ -930,7 +930,7 @@ function rewind_posts() { * * @since 1.5.0 * - * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_query WordPress Query object. */ function the_post() { global $wp_query; @@ -946,7 +946,7 @@ function the_post() { * * @since 2.2.0 * - * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_query WordPress Query object. * * @return bool */ @@ -960,7 +960,7 @@ function have_comments() { * * @since 2.2.0 * - * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_query WordPress Query object. * * @return object */ @@ -1127,7 +1127,7 @@ function _find_post_by_old_date( $post_type ) { * @since 1.5.0 * @since 4.4.0 Added the ability to pass a post ID to `$post`. * - * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_query WordPress Query object. * * @param WP_Post|object|int $post WP_Post instance or Post ID/object. * @return bool True when finished. @@ -1147,7 +1147,7 @@ function setup_postdata( $post ) { * * @since 5.2.0 * - * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_query WordPress Query object. * * @param WP_Post|object|int $post WP_Post instance or Post ID/object. * @return array|bool Elements of post, or false on failure. diff --git a/src/wp-includes/template.php b/src/wp-includes/template.php index 11fd37a3a4..c2ae8771b4 100644 --- a/src/wp-includes/template.php +++ b/src/wp-includes/template.php @@ -686,7 +686,7 @@ function locate_template( $template_names, $load = false, $require_once = true ) * @global array $posts * @global WP_Post $post * @global bool $wp_did_header - * @global WP_Query $wp_query + * @global WP_Query $wp_query WordPress Query object. * @global WP_Rewrite $wp_rewrite WordPress rewrite component. * @global wpdb $wpdb WordPress database abstraction object. * @global string $wp_version diff --git a/src/wp-settings.php b/src/wp-settings.php index 73b721433b..681053a0d4 100644 --- a/src/wp-settings.php +++ b/src/wp-settings.php @@ -406,7 +406,7 @@ do_action( 'sanitize_comment_cookies' ); /** * WordPress Query object * - * @global WP_Query $wp_the_query + * @global WP_Query $wp_the_query WordPress Query object. * @since 2.0.0 */ $GLOBALS['wp_the_query'] = new WP_Query(); @@ -415,7 +415,7 @@ $GLOBALS['wp_the_query'] = new WP_Query(); * Holds the reference to @see $wp_the_query * Use this global for WordPress queries * - * @global WP_Query $wp_query + * @global WP_Query $wp_query WordPress Query object. * @since 1.5.0 */ $GLOBALS['wp_query'] = $GLOBALS['wp_the_query'];