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
|
||||
|
|
@ -652,140 +652,140 @@ class WP_Query {
|
|||
* @param string|array $query {
|
||||
* Optional. Array or string of Query parameters.
|
||||
*
|
||||
* @type int $attachment_id Attachment post ID. Used for 'attachment' post_type.
|
||||
* @type int|string $author Author ID, or comma-separated list of IDs.
|
||||
* @type string $author_name User 'user_nicename'.
|
||||
* @type int[] $author__in An array of author IDs to query from.
|
||||
* @type int[] $author__not_in An array of author IDs not to query from.
|
||||
* @type bool $cache_results Whether to cache post information. Default true.
|
||||
* @type int|string $cat Category ID or comma-separated list of IDs (this or any children).
|
||||
* @type int[] $category__and An array of category IDs (AND in).
|
||||
* @type int[] $category__in An array of category IDs (OR in, no children).
|
||||
* @type int[] $category__not_in An array of category IDs (NOT in).
|
||||
* @type string $category_name Use category slug (not name, this or any children).
|
||||
* @type array|int $comment_count Filter results by comment count. Provide an integer to match
|
||||
* comment count exactly. Provide an array with integer 'value'
|
||||
* and 'compare' operator ('=', '!=', '>', '>=', '<', '<=' ) to
|
||||
* compare against comment_count in a specific way.
|
||||
* @type string $comment_status Comment status.
|
||||
* @type int $comments_per_page The number of comments to return per page.
|
||||
* Default 'comments_per_page' option.
|
||||
* @type array $date_query An associative array of WP_Date_Query arguments.
|
||||
* See WP_Date_Query::__construct().
|
||||
* @type int $day Day of the month. Default empty. Accepts numbers 1-31.
|
||||
* @type bool $exact Whether to search by exact keyword. Default false.
|
||||
* @type string $fields Post fields to query for. Accepts:
|
||||
* - '' Returns an array of complete post objects (`WP_Post[]`).
|
||||
* - 'ids' Returns an array of post IDs (`int[]`).
|
||||
* - 'id=>parent' Returns an associative array of parent post IDs,
|
||||
* keyed by post ID (`int[]`).
|
||||
* Default ''.
|
||||
* @type int $hour Hour of the day. Default empty. Accepts numbers 0-23.
|
||||
* @type int|bool $ignore_sticky_posts Whether to ignore sticky posts or not. Setting this to false
|
||||
* excludes stickies from 'post__in'. Accepts 1|true, 0|false.
|
||||
* Default false.
|
||||
* @type int $m Combination YearMonth. Accepts any four-digit year and month
|
||||
* numbers 01-12. Default empty.
|
||||
* @type string|string[] $meta_key Meta key or keys to filter by.
|
||||
* @type string|string[] $meta_value Meta value or values to filter by.
|
||||
* @type string $meta_compare MySQL operator used for comparing the meta value.
|
||||
* See WP_Meta_Query::__construct() for accepted values and default value.
|
||||
* @type string $meta_compare_key MySQL operator used for comparing the meta key.
|
||||
* See WP_Meta_Query::__construct() for accepted values and default value.
|
||||
* @type string $meta_type MySQL data type that the meta_value column will be CAST to for comparisons.
|
||||
* See WP_Meta_Query::__construct() for accepted values and default value.
|
||||
* @type string $meta_type_key MySQL data type that the meta_key column will be CAST to for comparisons.
|
||||
* See WP_Meta_Query::__construct() for accepted values and default value.
|
||||
* @type array $meta_query An associative array of WP_Meta_Query arguments.
|
||||
* See WP_Meta_Query::__construct() for accepted values.
|
||||
* @type int $menu_order The menu order of the posts.
|
||||
* @type int $minute Minute of the hour. Default empty. Accepts numbers 0-59.
|
||||
* @type int $monthnum The two-digit month. Default empty. Accepts numbers 1-12.
|
||||
* @type string $name Post slug.
|
||||
* @type bool $nopaging Show all posts (true) or paginate (false). Default false.
|
||||
* @type bool $no_found_rows Whether to skip counting the total rows found. Enabling can improve
|
||||
* performance. Default false.
|
||||
* @type int $offset The number of posts to offset before retrieval.
|
||||
* @type string $order Designates ascending or descending order of posts. Default 'DESC'.
|
||||
* Accepts 'ASC', 'DESC'.
|
||||
* @type string|array $orderby Sort retrieved posts by parameter. One or more options may be passed.
|
||||
* To use 'meta_value', or 'meta_value_num', 'meta_key=keyname' must be
|
||||
* also be defined. To sort by a specific `$meta_query` clause, use that
|
||||
* clause's array key. Accepts:
|
||||
* - 'none'
|
||||
* - 'name'
|
||||
* - 'author'
|
||||
* - 'date'
|
||||
* - 'title'
|
||||
* - 'modified'
|
||||
* - 'menu_order'
|
||||
* - 'parent'
|
||||
* - 'ID'
|
||||
* - 'rand'
|
||||
* - 'relevance'
|
||||
* - 'RAND(x)' (where 'x' is an integer seed value)
|
||||
* - 'comment_count'
|
||||
* - 'meta_value'
|
||||
* - 'meta_value_num'
|
||||
* - 'post__in'
|
||||
* - 'post_name__in'
|
||||
* - 'post_parent__in'
|
||||
* - The array keys of `$meta_query`.
|
||||
* Default is 'date', except when a search is being performed, when
|
||||
* the default is 'relevance'.
|
||||
* @type int $p Post ID.
|
||||
* @type int $page Show the number of posts that would show up on page X of a
|
||||
* static front page.
|
||||
* @type int $paged The number of the current page.
|
||||
* @type int $page_id Page ID.
|
||||
* @type string $pagename Page slug.
|
||||
* @type string $perm Show posts if user has the appropriate capability.
|
||||
* @type string $ping_status Ping status.
|
||||
* @type int[] $post__in An array of post IDs to retrieve, sticky posts will be included.
|
||||
* @type int[] $post__not_in An array of post IDs not to retrieve. Note: a string of comma-
|
||||
* separated IDs will NOT work.
|
||||
* @type string $post_mime_type The mime type of the post. Used for 'attachment' post_type.
|
||||
* @type string[] $post_name__in An array of post slugs that results must match.
|
||||
* @type int $post_parent Page ID to retrieve child pages for. Use 0 to only retrieve
|
||||
* top-level pages.
|
||||
* @type int[] $post_parent__in An array containing parent page IDs to query child pages from.
|
||||
* @type int[] $post_parent__not_in An array containing parent page IDs not to query child pages from.
|
||||
* @type string|string[] $post_type A post type slug (string) or array of post type slugs.
|
||||
* Default 'any' if using 'tax_query'.
|
||||
* @type string|string[] $post_status A post status (string) or array of post statuses.
|
||||
* @type int $posts_per_page The number of posts to query for. Use -1 to request all posts.
|
||||
* @type int $posts_per_archive_page The number of posts to query for by archive page. Overrides
|
||||
* 'posts_per_page' when is_archive(), or is_search() are true.
|
||||
* @type string $s Search keyword(s). Prepending a term with a hyphen will
|
||||
* exclude posts matching that term. Eg, 'pillow -sofa' will
|
||||
* return posts containing 'pillow' but not 'sofa'. The
|
||||
* character used for exclusion can be modified using the
|
||||
* the 'wp_query_search_exclusion_prefix' filter.
|
||||
* @type string[] $search_columns Array of column names to be searched. Accepts 'post_title',
|
||||
* 'post_excerpt' and 'post_content'. Default empty array.
|
||||
* @type int $second Second of the minute. Default empty. Accepts numbers 0-59.
|
||||
* @type bool $sentence Whether to search by phrase. Default false.
|
||||
* @type bool $suppress_filters Whether to suppress filters. Default false.
|
||||
* @type string $tag Tag slug. Comma-separated (either), Plus-separated (all).
|
||||
* @type int[] $tag__and An array of tag IDs (AND in).
|
||||
* @type int[] $tag__in An array of tag IDs (OR in).
|
||||
* @type int[] $tag__not_in An array of tag IDs (NOT in).
|
||||
* @type int $tag_id Tag id or comma-separated list of IDs.
|
||||
* @type string[] $tag_slug__and An array of tag slugs (AND in).
|
||||
* @type string[] $tag_slug__in An array of tag slugs (OR in). unless 'ignore_sticky_posts' is
|
||||
* true. Note: a string of comma-separated IDs will NOT work.
|
||||
* @type array $tax_query An associative array of WP_Tax_Query arguments.
|
||||
* See WP_Tax_Query::__construct().
|
||||
* @type string $title Post title.
|
||||
* @type bool $update_post_meta_cache Whether to update the post meta cache. Default true.
|
||||
* @type bool $update_post_term_cache Whether to update the post term cache. Default true.
|
||||
* @type bool $update_menu_item_cache Whether to update the menu item cache. Default false.
|
||||
* @type bool $lazy_load_term_meta Whether to lazy-load term meta. Setting to false will
|
||||
* disable cache priming for term meta, so that each
|
||||
* get_term_meta() call will hit the database.
|
||||
* Defaults to the value of `$update_post_term_cache`.
|
||||
* @type int $w The week number of the year. Default empty. Accepts numbers 0-53.
|
||||
* @type int $year The four-digit year. Default empty. Accepts any four-digit year.
|
||||
* @type int $attachment_id Attachment post ID. Used for 'attachment' post_type.
|
||||
* @type int|string $author Author ID, or comma-separated list of IDs.
|
||||
* @type string $author_name User 'user_nicename'.
|
||||
* @type int[] $author__in An array of author IDs to query from.
|
||||
* @type int[] $author__not_in An array of author IDs not to query from.
|
||||
* @type bool $cache_results Whether to cache post information. Default true.
|
||||
* @type int|string $cat Category ID or comma-separated list of IDs (this or any children).
|
||||
* @type int[] $category__and An array of category IDs (AND in).
|
||||
* @type int[] $category__in An array of category IDs (OR in, no children).
|
||||
* @type int[] $category__not_in An array of category IDs (NOT in).
|
||||
* @type string $category_name Use category slug (not name, this or any children).
|
||||
* @type array|int $comment_count Filter results by comment count. Provide an integer to match
|
||||
* comment count exactly. Provide an array with integer 'value'
|
||||
* and 'compare' operator ('=', '!=', '>', '>=', '<', '<=' ) to
|
||||
* compare against comment_count in a specific way.
|
||||
* @type string $comment_status Comment status.
|
||||
* @type int $comments_per_page The number of comments to return per page.
|
||||
* Default 'comments_per_page' option.
|
||||
* @type array $date_query An associative array of WP_Date_Query arguments.
|
||||
* See WP_Date_Query::__construct().
|
||||
* @type int $day Day of the month. Default empty. Accepts numbers 1-31.
|
||||
* @type bool $exact Whether to search by exact keyword. Default false.
|
||||
* @type string $fields Post fields to query for. Accepts:
|
||||
* - '' Returns an array of complete post objects (`WP_Post[]`).
|
||||
* - 'ids' Returns an array of post IDs (`int[]`).
|
||||
* - 'id=>parent' Returns an associative array of parent post IDs,
|
||||
* keyed by post ID (`int[]`).
|
||||
* Default ''.
|
||||
* @type int $hour Hour of the day. Default empty. Accepts numbers 0-23.
|
||||
* @type int|bool $ignore_sticky_posts Whether to ignore sticky posts or not. Setting this to false
|
||||
* excludes stickies from 'post__in'. Accepts 1|true, 0|false.
|
||||
* Default false.
|
||||
* @type int $m Combination YearMonth. Accepts any four-digit year and month
|
||||
* numbers 01-12. Default empty.
|
||||
* @type string|string[] $meta_key Meta key or keys to filter by.
|
||||
* @type string|string[] $meta_value Meta value or values to filter by.
|
||||
* @type string $meta_compare MySQL operator used for comparing the meta value.
|
||||
* See WP_Meta_Query::__construct() for accepted values and default value.
|
||||
* @type string $meta_compare_key MySQL operator used for comparing the meta key.
|
||||
* See WP_Meta_Query::__construct() for accepted values and default value.
|
||||
* @type string $meta_type MySQL data type that the meta_value column will be CAST to for comparisons.
|
||||
* See WP_Meta_Query::__construct() for accepted values and default value.
|
||||
* @type string $meta_type_key MySQL data type that the meta_key column will be CAST to for comparisons.
|
||||
* See WP_Meta_Query::__construct() for accepted values and default value.
|
||||
* @type array $meta_query An associative array of WP_Meta_Query arguments.
|
||||
* See WP_Meta_Query::__construct() for accepted values.
|
||||
* @type int $menu_order The menu order of the posts.
|
||||
* @type int $minute Minute of the hour. Default empty. Accepts numbers 0-59.
|
||||
* @type int $monthnum The two-digit month. Default empty. Accepts numbers 1-12.
|
||||
* @type string $name Post slug.
|
||||
* @type bool $nopaging Show all posts (true) or paginate (false). Default false.
|
||||
* @type bool $no_found_rows Whether to skip counting the total rows found. Enabling can improve
|
||||
* performance. Default false.
|
||||
* @type int $offset The number of posts to offset before retrieval.
|
||||
* @type string $order Designates ascending or descending order of posts. Default 'DESC'.
|
||||
* Accepts 'ASC', 'DESC'.
|
||||
* @type string|array $orderby Sort retrieved posts by parameter. One or more options may be passed.
|
||||
* To use 'meta_value', or 'meta_value_num', 'meta_key=keyname' must be
|
||||
* also be defined. To sort by a specific `$meta_query` clause, use that
|
||||
* clause's array key. Accepts:
|
||||
* - 'none'
|
||||
* - 'name'
|
||||
* - 'author'
|
||||
* - 'date'
|
||||
* - 'title'
|
||||
* - 'modified'
|
||||
* - 'menu_order'
|
||||
* - 'parent'
|
||||
* - 'ID'
|
||||
* - 'rand'
|
||||
* - 'relevance'
|
||||
* - 'RAND(x)' (where 'x' is an integer seed value)
|
||||
* - 'comment_count'
|
||||
* - 'meta_value'
|
||||
* - 'meta_value_num'
|
||||
* - 'post__in'
|
||||
* - 'post_name__in'
|
||||
* - 'post_parent__in'
|
||||
* - The array keys of `$meta_query`.
|
||||
* Default is 'date', except when a search is being performed, when
|
||||
* the default is 'relevance'.
|
||||
* @type int $p Post ID.
|
||||
* @type int $page Show the number of posts that would show up on page X of a
|
||||
* static front page.
|
||||
* @type int $paged The number of the current page.
|
||||
* @type int $page_id Page ID.
|
||||
* @type string $pagename Page slug.
|
||||
* @type string $perm Show posts if user has the appropriate capability.
|
||||
* @type string $ping_status Ping status.
|
||||
* @type int[] $post__in An array of post IDs to retrieve, sticky posts will be included.
|
||||
* @type int[] $post__not_in An array of post IDs not to retrieve. Note: a string of comma-
|
||||
* separated IDs will NOT work.
|
||||
* @type string $post_mime_type The mime type of the post. Used for 'attachment' post_type.
|
||||
* @type string[] $post_name__in An array of post slugs that results must match.
|
||||
* @type int $post_parent Page ID to retrieve child pages for. Use 0 to only retrieve
|
||||
* top-level pages.
|
||||
* @type int[] $post_parent__in An array containing parent page IDs to query child pages from.
|
||||
* @type int[] $post_parent__not_in An array containing parent page IDs not to query child pages from.
|
||||
* @type string|string[] $post_type A post type slug (string) or array of post type slugs.
|
||||
* Default 'any' if using 'tax_query'.
|
||||
* @type string|string[] $post_status A post status (string) or array of post statuses.
|
||||
* @type int $posts_per_page The number of posts to query for. Use -1 to request all posts.
|
||||
* @type int $posts_per_archive_page The number of posts to query for by archive page. Overrides
|
||||
* 'posts_per_page' when is_archive(), or is_search() are true.
|
||||
* @type string $s Search keyword(s). Prepending a term with a hyphen will
|
||||
* exclude posts matching that term. Eg, 'pillow -sofa' will
|
||||
* return posts containing 'pillow' but not 'sofa'. The
|
||||
* character used for exclusion can be modified using the
|
||||
* the 'wp_query_search_exclusion_prefix' filter.
|
||||
* @type string[] $search_columns Array of column names to be searched. Accepts 'post_title',
|
||||
* 'post_excerpt' and 'post_content'. Default empty array.
|
||||
* @type int $second Second of the minute. Default empty. Accepts numbers 0-59.
|
||||
* @type bool $sentence Whether to search by phrase. Default false.
|
||||
* @type bool $suppress_filters Whether to suppress filters. Default false.
|
||||
* @type string $tag Tag slug. Comma-separated (either), Plus-separated (all).
|
||||
* @type int[] $tag__and An array of tag IDs (AND in).
|
||||
* @type int[] $tag__in An array of tag IDs (OR in).
|
||||
* @type int[] $tag__not_in An array of tag IDs (NOT in).
|
||||
* @type int $tag_id Tag id or comma-separated list of IDs.
|
||||
* @type string[] $tag_slug__and An array of tag slugs (AND in).
|
||||
* @type string[] $tag_slug__in An array of tag slugs (OR in). unless 'ignore_sticky_posts' is
|
||||
* true. Note: a string of comma-separated IDs will NOT work.
|
||||
* @type array $tax_query An associative array of WP_Tax_Query arguments.
|
||||
* See WP_Tax_Query::__construct().
|
||||
* @type string $title Post title.
|
||||
* @type bool $update_post_meta_cache Whether to update the post meta cache. Default true.
|
||||
* @type bool $update_post_term_cache Whether to update the post term cache. Default true.
|
||||
* @type bool $update_menu_item_cache Whether to update the menu item cache. Default false.
|
||||
* @type bool $lazy_load_term_meta Whether to lazy-load term meta. Setting to false will
|
||||
* disable cache priming for term meta, so that each
|
||||
* get_term_meta() call will hit the database.
|
||||
* Defaults to the value of `$update_post_term_cache`.
|
||||
* @type int $w The week number of the year. Default empty. Accepts numbers 0-53.
|
||||
* @type int $year The four-digit year. Default empty. Accepts any four-digit year.
|
||||
* }
|
||||
*/
|
||||
public function parse_query( $query = '' ) {
|
||||
|
|
@ -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