Docs: Improve various docblock in `WP_Query` class, as per docblock standards.
See #57840. Built from https://develop.svn.wordpress.org/trunk@55887 git-svn-id: http://core.svn.wordpress.org/trunk@55399 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
audrasjb
parent
d3d5fbbfc7
commit
b62f326588
|
|
@ -540,7 +540,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Reparse the query vars.
|
||||
* Reparses the query vars.
|
||||
*
|
||||
* @since 1.5.0
|
||||
*/
|
||||
|
|
@ -632,7 +632,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Parse a query string and set query type booleans.
|
||||
* Parses a query string and sets query type booleans.
|
||||
*
|
||||
* @since 1.5.0
|
||||
* @since 4.2.0 Introduced the ability to order by specific clauses of a `$meta_query`, by passing the clause's
|
||||
|
|
@ -1503,7 +1503,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Check if the terms are suitable for searching.
|
||||
* Checks if the terms are suitable for searching.
|
||||
*
|
||||
* Uses an array of stopwords (terms) that are excluded from the separate
|
||||
* term matching when searching for posts. The list of English stopwords is
|
||||
|
|
@ -1544,7 +1544,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Retrieve stopwords used when parsing search terms.
|
||||
* Retrieves stopwords used when parsing search terms.
|
||||
*
|
||||
* @since 3.7.0
|
||||
*
|
||||
|
|
@ -3540,7 +3540,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Set up the amount of found posts and the number of pages (if limit clause was used)
|
||||
* Sets up the amount of found posts and the number of pages (if limit clause was used)
|
||||
* for the current query.
|
||||
*
|
||||
* @since 3.5.0
|
||||
|
|
@ -3599,7 +3599,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Set up the next post and iterate current post index.
|
||||
* Sets up the next post and iterate current post index.
|
||||
*
|
||||
* @since 1.5.0
|
||||
*
|
||||
|
|
@ -3698,7 +3698,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Rewind the posts and reset post index.
|
||||
* Rewinds the posts and resets post index.
|
||||
*
|
||||
* @since 1.5.0
|
||||
*/
|
||||
|
|
@ -3710,7 +3710,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Iterate current comment index and return WP_Comment object.
|
||||
* Iterates current comment index and returns WP_Comment object.
|
||||
*
|
||||
* @since 2.2.0
|
||||
*
|
||||
|
|
@ -3747,7 +3747,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Whether there are more comments available.
|
||||
* Determines whether there are more comments available.
|
||||
*
|
||||
* Automatically rewinds comments when finished.
|
||||
*
|
||||
|
|
@ -3766,7 +3766,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Rewind the comments, resets the comment index and comment to first.
|
||||
* Rewinds the comments, resets the comment index and comment to first.
|
||||
*
|
||||
* @since 2.2.0
|
||||
*/
|
||||
|
|
@ -3928,7 +3928,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Make private properties readable for backward compatibility.
|
||||
* Makes private properties readable for backward compatibility.
|
||||
*
|
||||
* @since 4.0.0
|
||||
*
|
||||
|
|
@ -3942,7 +3942,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Make private properties checkable for backward compatibility.
|
||||
* Makes private properties checkable for backward compatibility.
|
||||
*
|
||||
* @since 4.0.0
|
||||
*
|
||||
|
|
@ -3956,7 +3956,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Make private/protected methods readable for backward compatibility.
|
||||
* Makes private/protected methods readable for backward compatibility.
|
||||
*
|
||||
* @since 4.0.0
|
||||
*
|
||||
|
|
@ -3972,7 +3972,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Is the query for an existing archive page?
|
||||
* Determines whether the query is for an existing archive page.
|
||||
*
|
||||
* Archive pages include category, tag, author, date, custom post type,
|
||||
* and custom taxonomy based archives.
|
||||
|
|
@ -3993,7 +3993,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Is the query for an existing post type archive page?
|
||||
* Determines whether the query is for an existing post type archive page.
|
||||
*
|
||||
* @since 3.1.0
|
||||
*
|
||||
|
|
@ -4020,7 +4020,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Is the query for an existing attachment page?
|
||||
* Determines whether the query is for an existing attachment page.
|
||||
*
|
||||
* @since 3.1.0
|
||||
*
|
||||
|
|
@ -4055,7 +4055,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Is the query for an existing author archive page?
|
||||
* Determines whether the query is for an existing author archive page.
|
||||
*
|
||||
* If the $author parameter is specified, this function will additionally
|
||||
* check if the query is for one of the authors specified.
|
||||
|
|
@ -4094,7 +4094,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Is the query for an existing category archive page?
|
||||
* Determines whether the query is for an existing category archive page.
|
||||
*
|
||||
* If the $category parameter is specified, this function will additionally
|
||||
* check if the query is for one of the categories specified.
|
||||
|
|
@ -4133,7 +4133,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Is the query for an existing tag archive page?
|
||||
* Determines whether the query is for an existing tag archive page.
|
||||
*
|
||||
* If the $tag parameter is specified, this function will additionally
|
||||
* check if the query is for one of the tags specified.
|
||||
|
|
@ -4172,7 +4172,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Is the query for an existing custom taxonomy archive page?
|
||||
* Determines whether the query is for an existing custom taxonomy archive page.
|
||||
*
|
||||
* If the $taxonomy parameter is specified, this function will additionally
|
||||
* check if the query is for that specific $taxonomy.
|
||||
|
|
@ -4228,7 +4228,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Whether the current URL is within the comments popup window.
|
||||
* Determines whether the current URL is within the comments popup window.
|
||||
*
|
||||
* @since 3.1.0
|
||||
* @deprecated 4.5.0
|
||||
|
|
@ -4242,7 +4242,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Is the query for an existing date archive?
|
||||
* Determines whether the query is for an existing date archive.
|
||||
*
|
||||
* @since 3.1.0
|
||||
*
|
||||
|
|
@ -4253,7 +4253,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Is the query for an existing day archive?
|
||||
* Determines whether the query is for an existing day archive.
|
||||
*
|
||||
* @since 3.1.0
|
||||
*
|
||||
|
|
@ -4264,7 +4264,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Is the query for a feed?
|
||||
* Determines whether the query is for a feed.
|
||||
*
|
||||
* @since 3.1.0
|
||||
*
|
||||
|
|
@ -4286,7 +4286,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Is the query for a comments feed?
|
||||
* Determines whether the query is for a comments feed.
|
||||
*
|
||||
* @since 3.1.0
|
||||
*
|
||||
|
|
@ -4297,7 +4297,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Is the query for the front page of the site?
|
||||
* Determines whether the query is for the front page of the site.
|
||||
*
|
||||
* This is for what is displayed at your site's main URL.
|
||||
*
|
||||
|
|
@ -4326,7 +4326,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Is the query for the blog homepage?
|
||||
* Determines whether the query is for the blog homepage.
|
||||
*
|
||||
* This is the page which shows the time based blog content of your site.
|
||||
*
|
||||
|
|
@ -4346,7 +4346,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Is the query for the Privacy Policy page?
|
||||
* Determines whether the query is for the Privacy Policy page.
|
||||
*
|
||||
* This is the page which shows the Privacy Policy content of your site.
|
||||
*
|
||||
|
|
@ -4369,7 +4369,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Is the query for an existing month archive?
|
||||
* Determines whether the query is for an existing month archive.
|
||||
*
|
||||
* @since 3.1.0
|
||||
*
|
||||
|
|
@ -4380,7 +4380,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Is the query for an existing single page?
|
||||
* Determines whether the query is for an existing single page.
|
||||
*
|
||||
* If the $page parameter is specified, this function will additionally
|
||||
* check if the query is for one of the pages specified.
|
||||
|
|
@ -4433,7 +4433,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Is the query for a paged result and not for the first page?
|
||||
* Determines whether the query is for a paged result and not for the first page.
|
||||
*
|
||||
* @since 3.1.0
|
||||
*
|
||||
|
|
@ -4444,7 +4444,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Is the query for a post or page preview?
|
||||
* Determines whether the query is for a post or page preview.
|
||||
*
|
||||
* @since 3.1.0
|
||||
*
|
||||
|
|
@ -4455,7 +4455,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Is the query for the robots.txt file?
|
||||
* Determines whether the query is for the robots.txt file.
|
||||
*
|
||||
* @since 3.1.0
|
||||
*
|
||||
|
|
@ -4466,7 +4466,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Is the query for the favicon.ico file?
|
||||
* Determines whether the query is for the favicon.ico file.
|
||||
*
|
||||
* @since 5.4.0
|
||||
*
|
||||
|
|
@ -4477,7 +4477,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Is the query for a search?
|
||||
* Determines whether the query is for a search.
|
||||
*
|
||||
* @since 3.1.0
|
||||
*
|
||||
|
|
@ -4488,7 +4488,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Is the query for an existing single post?
|
||||
* Determines whether the query is for an existing single post.
|
||||
*
|
||||
* Works for any post type excluding pages.
|
||||
*
|
||||
|
|
@ -4542,8 +4542,8 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Is the query for an existing single post of any post type (post, attachment, page,
|
||||
* custom post types)?
|
||||
* Determines whether the query is for an existing single post of any post type
|
||||
* (post, attachment, page, custom post types).
|
||||
*
|
||||
* If the $post_types parameter is specified, this function will additionally
|
||||
* check if the query is for one of the Posts Types specified.
|
||||
|
|
@ -4572,7 +4572,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Is the query for a specific time?
|
||||
* Determines whether the query is for a specific time.
|
||||
*
|
||||
* @since 3.1.0
|
||||
*
|
||||
|
|
@ -4583,7 +4583,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Is the query for a trackback endpoint call?
|
||||
* Determines whether the query is for a trackback endpoint call.
|
||||
*
|
||||
* @since 3.1.0
|
||||
*
|
||||
|
|
@ -4594,7 +4594,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Is the query for an existing year archive?
|
||||
* Determines whether the query is for an existing year archive.
|
||||
*
|
||||
* @since 3.1.0
|
||||
*
|
||||
|
|
@ -4605,7 +4605,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Is the query a 404 (returns no results)?
|
||||
* Determines whether the query is a 404 (returns no results).
|
||||
*
|
||||
* @since 3.1.0
|
||||
*
|
||||
|
|
@ -4616,7 +4616,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Is the query for an embedded post?
|
||||
* Determines whether the query is for an embedded post.
|
||||
*
|
||||
* @since 4.4.0
|
||||
*
|
||||
|
|
@ -4627,7 +4627,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Is the query the main query?
|
||||
* Determines whether the query is the main query.
|
||||
*
|
||||
* @since 3.3.0
|
||||
*
|
||||
|
|
@ -4641,7 +4641,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Set up global post data.
|
||||
* Sets up global post data.
|
||||
*
|
||||
* @since 4.1.0
|
||||
* @since 4.4.0 Added the ability to pass a post ID to `$post`.
|
||||
|
|
@ -4700,7 +4700,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Generate post data.
|
||||
* Generates post data.
|
||||
*
|
||||
* @since 5.2.0
|
||||
*
|
||||
|
|
@ -4803,7 +4803,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Generate cache key.
|
||||
* Generates cache key.
|
||||
*
|
||||
* @since 6.1.0
|
||||
*
|
||||
|
|
@ -4811,7 +4811,6 @@ class WP_Query {
|
|||
*
|
||||
* @param array $args Query arguments.
|
||||
* @param string $sql SQL statement.
|
||||
*
|
||||
* @return string Cache key.
|
||||
*/
|
||||
protected function generate_cache_key( array $args, $sql ) {
|
||||
|
|
@ -4873,7 +4872,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Lazyload term meta for posts in the loop.
|
||||
* Lazyloads term meta for posts in the loop.
|
||||
*
|
||||
* @since 4.4.0
|
||||
* @deprecated 4.5.0 See wp_queue_posts_for_term_meta_lazyload().
|
||||
|
|
@ -4888,7 +4887,7 @@ class WP_Query {
|
|||
}
|
||||
|
||||
/**
|
||||
* Lazyload comment meta for comments in the loop.
|
||||
* Lazyloads comment meta for comments in the loop.
|
||||
*
|
||||
* @since 4.4.0
|
||||
* @deprecated 4.5.0 See wp_lazyload_comment_meta().
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@
|
|||
*
|
||||
* @global string $wp_version
|
||||
*/
|
||||
$wp_version = '6.3-alpha-55886';
|
||||
$wp_version = '6.3-alpha-55887';
|
||||
|
||||
/**
|
||||
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.
|
||||
|
|
|
|||
Loading…
Reference in New Issue