First-run documention of `WP_Query` argument defaults.
Props siobhan for some language tweaks. Props DrewAPicture. See #25367. Built from https://develop.svn.wordpress.org/trunk@28887 git-svn-id: http://core.svn.wordpress.org/trunk@28686 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes
parent
62075239b8
commit
ff109ddc5a
|
|
@ -1449,7 +1449,97 @@ class WP_Query {
|
|||
* @since 1.5.0
|
||||
* @access public
|
||||
*
|
||||
* @param string|array $query Optional 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 array $author__in An array of author IDs to query from.
|
||||
* @type array $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 array $category__and An array of category IDs (AND in).
|
||||
* @type array $category__in An array of category IDs (OR in, no children).
|
||||
* @type array $category__not_in An array of category IDs (NOT in).
|
||||
* @type string $category_name Use category slug (not name, this or any children).
|
||||
* @type int $comments_per_page The number of comments to return per page.
|
||||
* Default 'comments_per_page' option.
|
||||
* @type int|string $comments_popup Whether the query is within the comments popup. Default empty.
|
||||
* @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|array $fields Which fields to return. Single field or all fields (string),
|
||||
* or array of fields. 'id=>parent' uses 'id' and 'post_parent'.
|
||||
* Default all fields. Accepts 'ids', 'id=>parent'.
|
||||
* @type int $hour Hour of the day. Default empty. Accepts numbers 0-23.
|
||||
* @type bool $ignore_sticky_posts Whether to ignore sticky posts or not. Setting this to false
|
||||
* excludes stickies from 'post__in'. Default 0|false. Accepts
|
||||
* 1|true, 0|false.
|
||||
* @type int $m Combination YearMonth. Default empty. Accepts any four-digit
|
||||
* year and month numbers 1-12.
|
||||
* @type string $meta_compare Comparison operator to test the 'meta_value'.
|
||||
* @type string $meta_key Custom field key.
|
||||
* @type array $meta_query An associative array of WP_Meta_Query arguments.
|
||||
* {@see WP_Meta_Query->queries}
|
||||
* @type string $meta_value Custom field value.
|
||||
* @type int $meta_value_num Custom field value number.
|
||||
* @type int $menu_order The menu order of the posts.
|
||||
* @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 count the total rows found. Disabling can improve
|
||||
* performance. Default true.
|
||||
* @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 $orderby Sort retrieved posts by parameter. One or more options can be
|
||||
* passed. To use 'meta_value', or 'meta_value_num',
|
||||
* 'meta_key=keyname' must be also be defined. Default 'date'.
|
||||
* Accepts 'none', 'name', 'author', 'date', 'title', 'modified',
|
||||
* 'menu_order', 'parent', 'ID', 'rand', 'comment_count'.
|
||||
* @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 array $post__in An array of post IDs to retrieve, sticky posts will be included
|
||||
* @type string $post_mime_type The mime type of the post. Used for 'attachment' post_type.
|
||||
* @type array $post__not_in An array of post IDs not to retrieve. Note: a string of comma-
|
||||
* @type int $post_parent Page ID to retrieve child pages for. Use 0 to only retrieve
|
||||
* top-level pages.
|
||||
* @type array $post_parent__in An array containing parent page IDs to query child pages from.
|
||||
* @type array $post_parent__not_in An array containing parent page IDs not to query child pages from.
|
||||
* separated IDs will NOT work.
|
||||
* @type string|array $post_type A post type slug (string) or array of post type slugs.
|
||||
* Default 'any' if using 'tax_query'.
|
||||
* @type string|array $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.
|
||||
* @type int $second Second of the minute. Default empty. Accepts numbers 0-60.
|
||||
* @type array $search_terms Array of search terms.
|
||||
* @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 array $tag__and An array of tag ids (AND in).
|
||||
* @type array $tag__in An array of tag ids (OR in).
|
||||
* @type array $tag__not_in An array of tag ids (NOT in).
|
||||
* @type int $tag_id Tag id or comma-separated list of IDs.
|
||||
* @type array $tag_slug__and An array of tag slugs (AND in).
|
||||
* @type array $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->queries}
|
||||
* @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 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 = '' ) {
|
||||
if ( ! empty( $query ) ) {
|
||||
|
|
|
|||
Loading…
Reference in New Issue