Skip to content

Instantly share code, notes, and snippets.

@EkoJR

EkoJR/wp_query-args.md

Last active November 29, 2022 05:58
Show Gist options
  • Save EkoJR/b0de2587cd193d56cfde859de5d8ff30 to your computer and use it in GitHub Desktop.
Save EkoJR/b0de2587cd193d56cfde859de5d8ff30 to your computer and use it in GitHub Desktop.
Download ZIP
WP Query $args - Reference for params / args in . Ex. WP_Query( $args )
Raw
wp_query-args.md
Raw
wp_query-args.php
<?php
/**
* WordPress Query Args
*
* CODE REF: https://developer.wordpress.org/reference/classes/wp_query/
* CODEX: http://codex.wordpress.org/Class_Reference/WP_Query#Parameters
* Source: https://core.trac.wordpress.org/browser/trunk/src/wp-includes/query.php
* Source: https://core.trac.wordpress.org/browser/trunk/src/wp-includes/class-wp-query.php
*/
$args = array(
////// AUTHOR Parameters - Show posts associated with certain author.
//http://codex.wordpress.org/Class_Reference/WP_Query#Author_Parameters
'author' => '1,2,-3,', //(int) - use author id [use minus (-) to exclude authors by ID]
'author_name' => 'sample_name', //(string) - use 'user_nicename' (NOT name)
'author__in' => array( 2, 6 ), //(array) - use author id (available with Version 3.7).
'author__not_in' => array( 2, 6 ), //(array) - use author id (available with Version 3.7).
////// CATEGORY Parameters - Show posts associated with certain categories.
//http://codex.wordpress.org/Class_Reference/WP_Query#Category_Parameters
'cat' => 5, //(int) - use category id.
'cat' => '2,6,7',
'category_name' => 'staff, news', //(string) - Display posts that have these categories, using category slug.
'category_name' => 'staff+news', //(string) - Display posts that have "all" of these categories, using category slug.
'category__and' => array( 2, 6 ), //(array) - use category id.
'category__in' => array( 2, 6 ), //(array) - use category id.
'category__not_in' => array( 2, 6 ), //(array) - use category id.
////// TAG Parameters - Show posts associated with certain tags.
//http://codex.wordpress.org/Class_Reference/WP_Query#Tag_Parameters
'tag' => 'cooking', //(string) - use tag slug.
'tag_id' => 5, //(int) - use tag id.
'tag__and' => array( 2, 6), //(array) - use tag ids.
'tag__in' => array( 2, 6), //(array) - use tag ids.
'tag__not_in' => array( 2, 6), //(array) - use tag ids.
'tag_slug__and' => array( 'red', 'blue'), //(array) - use tag slugs.
'tag_slug__in' => array( 'red', 'blue'), //(array) - use tag slugs.
////// TAXONOMY Parameters - Show posts associated with certain taxonomy.
//http://codex.wordpress.org/Class_Reference/WP_Query#Taxonomy_Parameters
//Important Note: tax_query takes an array of tax query arguments arrays (it takes an array of arrays)
//This construct allows you to query multiple taxonomies by using the relation parameter in the first (outer) array to describe the boolean relationship between the taxonomy queries.
'tax_query' => array( //(array) - use taxonomy parameters (available with Version 3.1).
'relation' => 'AND', //(string) - Relationship between meultiple taxonomy arrays. Possible values are 'AND' or 'OR'. Default: 'AND'.
array(
'taxonomy' => 'category', //(string) - Taxonomy slug.
'field' => 'term_id', //(string) - Select taxonomy term by. Possible values are 'term_id', 'name', 'slug' or 'term_taxonomy_id'. Default: 'term_id'
'terms' => array( 10, 15, 20 ), //(int/string/array) - Taxonomy term(s).
'include_children' => true, //(bool) - Whether or not to include children for hierarchical taxonomies. Defaults to true.
'operator' => 'IN' //(string) - Operator to test. Possible values are 'IN', 'NOT IN', 'AND', 'EXISTS', and 'NOT EXISTS'. Default: 'IN'.
),
array(
'taxonomy' => 'actor',
'field' => 'slug',
'terms' => array( 'red', 'blue' ),
'include_children' => false,
'operator' => 'NOT IN'
)
),
//Nested Taxonomy Handling. - The 'tax_query' clauses can be nested, to create more complex queries.
//Example: Display posts that are in the quotes category OR both have the quote post format AND are in the wisdom category:
'tax_query' => array(
'relation' => 'OR',
array(
'taxonomy' => 'category',
'field' => 'slug',
'terms' => array( 'quotes' ),
),
array(
'relation' => 'AND',
array(
'taxonomy' => 'post_format',
'field' => 'slug',
'terms' => array( 'post-format-quote' ),
),
array(
'taxonomy' => 'category',
'field' => 'slug',
'terms' => array( 'wisdom' ),
),
),
),
////// SEARCH Parameter
//http://codex.wordpress.org/Class_Reference/WP_Query#Search_Parameter
's' => $s, //(string) - Passes along the query string variable from a search.
// For example usage see: http://www.wprecipes.com/how-to-display-the-number-of-results-in-wordpress-search
'exact' => true, //(bool) - flag to make it only match whole titles/posts - Default value is false.
// For more information see: https://gist.github.com/2023628#gistcomment-285118
'sentence' => true, //(bool) - flag to make it do a phrase search - Default value is false.
// For more information see: https://gist.github.com/2023628#gistcomment-285118
////// POST/PAGE Parameters - Display content based on post and page parameters.
//http://codex.wordpress.org/Class_Reference/WP_Query#Post_.26_Page_Parameters
'p' => 1, //(int) - use post id.
'name' => 'hello-world', //(string) - use post slug.
'title' => 'Hello World', //(string) - use post title.
'page_id' => 1, //(int) - use page id.
'pagename' => 'sample-page', //(string) - use page slug.
'pagename' => 'contact/us', //(string) - Display child page using the slug of the parent and the child page, separated ba slash
'post_parent' => 1, //(int) - use page id. Return just the child Pages. (Only works with heirachical post types.)
'post_parent__in' => array(1,2,3) //(array) - use post ids. Specify posts whose parent is in an array. NOTE: Introduced in 3.6
'post_parent__not_in' => array(1,2,3), //(array) - use post ids. Specify posts whose parent is not in an array.
'post__in' => array(1,2,3), //(array) - use post ids. Specify posts to retrieve. ATTENTION If you use sticky posts,
// they will be included (prepended!) in the posts you retrieve whether you want it or not.
// To suppress this behaviour use ignore_sticky_posts
'post__not_in' => array(1,2,3), //(array) - use post ids. Specify post NOT to retrieve.
'post_name__in' => array( 'sample-post' ), //(array) - use post slugs. Specify posts to retrieve.
//NOTE: you cannot combine 'post__in' and 'post__not_in' in the same query
////// PASSWORD Parameters - Show content based on post and page parameters. Remember that default post_type is only set to display posts but not pages.
//http://codex.wordpress.org/Class_Reference/WP_Query#Password_Parameters
'has_password' => true, //(bool) - available with Version 3.9
// true for posts with passwords;
// false for posts without passwords;
// null for all posts with and without passwords
'post_password' => 'multi-pass', //(string) - show posts with a particular password (available with Version 3.9)
////// POST TYPE Parameters - Show posts associated with certain post type.
//http://codex.wordpress.org/Class_Reference/WP_Query#Type_Parameters
'post_type' => array( //(string / array) - use post types. Retrieves posts by Post Types, default value is 'post';
'post', // - a post.
'page', // - a page.
'revision', // - a revision.
'attachment', // - an attachment. The default WP_Query sets 'post_status'=>'published',
// but atchments default to 'post_status'=>'inherit' so you'll need to set the status to 'inherit' or 'any'.
'nav_menu_item' // - a navigation menu item
'my-custom-post-type', // - Custom Post Types (e.g. movies)
),
//NOTE: The 'any' keyword available to both post_type and post_status queries cannot be used within an array.
'post_type' => 'any', // - retrieves any type except revisions and types with 'exclude_from_search' set to true.
////// POST STATUS Parameters - Show posts associated with certain status.
//http://codex.wordpress.org/Class_Reference/WP_Query#Status_Parameters
'post_status' => array( //(string / array) - use post status. Retrieves posts by Post Status, default value i'publish'.
'publish', // - a published post or page.
'pending', // - post is pending review.
'draft', // - a post in draft status.
'auto-draft', // - a newly created post, with no content.
'future', // - a post to publish in the future.
'private', // - not visible to users who are not logged in.
'inherit', // - a revision. see get_children.
'trash' // - post is in trashbin (available with Version 2.9).
),
//NOTE: The 'any' keyword available to both post_type and post_status queries cannot be used within an array.
'post_status' => 'any', // - retrieves any status except those from post types with 'exclude_from_search' set to true.
////// Comment Paremters - @since Version 4.9 Introduced the `$comment_count` parameter.
// https://codex.wordpress.org/Class_Reference/WP_Query#Comment_Parameters
'comment_count' => 10 // (int | array) - The amount of comments your CPT has to have ( Search operator will do a '=' operation ).
'comment_count' => array(
'value' => 10 // (int) - The amount of comments your CPT has to have when comparing.
'compare' => '=' // (string) - The search operator. Possible values are '=', '!=', '>', '>=', '<', '<='. Default value is '='.
)
////// PAGINATION Parameters
//http://codex.wordpress.org/Class_Reference/WP_Query#Pagination_Parameters
'nopaging' => false, //(bool) - show all posts or use pagination. Default value is 'false', use paging.
'posts_per_page' => 10, //(int) - number of post to show per page (available with Version 2.1). Use 'posts_per_page' => -1 to show all posts.
// Note: if the query is in a feed, wordpress overwrites this parameter with the stored 'posts_per_rss' option.
// Treimpose the limit, try using the 'post_limits' filter, or filter 'pre_option_posts_per_rss' and return -1
'posts_per_archive_page' => 10, //(int) - number of posts to show per page - on archive pages only.
// Over-rides posts_per_page and showposts on pages where is_archive() or is_search() would be true.
'offset' => 3, //(int) - number of post to displace or pass over.
// Warning: Setting the offset parameter overrides/ignores the paged parameter and breaks pagination.
// For a workaround see: http://codex.wordpress.org/Making_Custom_Queries_using_Offset_and_Pagination
// The 'offset' parameter is ignored when 'posts_per_page'=>-1 (show all posts) is used.
'paged' => get_query_var('paged'), //(int) - number of page. Show the posts that would normally show up just on page X when usinthe "Older Entries" link.
// NOTE: Advanced. Some links to help you out:
// http://codex.wordpress.org/Function_Reference/next_posts_link#Usage_when_querying_the_loop_with_WP_Query
// http://codex.wordpress.org/Pagination#Troubleshooting_Broken_Pagination
'page' => 1, //(int) - number of page for a static front page. Show the posts that would normally show up just on page X of a Static Front Page.
'ignore_sticky_posts' => false, //(bool) - ignore sticky posts or not (available with Version 3.1, replaced caller_get_posts parameter).
// Default value is 0 - don't ignore sticky posts. Note: ignore/exclude sticky posts being included at the beginning of posts returned,
// but the sticky post will still be returned in the natural order of that list of posts returned.
////// ORDER & ORDERBY Parameters - Sort retrieved posts.
//http://codex.wordpress.org/Class_Reference/WP_Query#Order_.26_Orderby_Parameters
'order' => 'DESC', //(string) - Designates the ascending or descending order of the 'orderby' parameter.
// Possible Values: Default to 'DESC'.
// 'ASC' - ascending order from lowest to highest values (1, 2, 3; a, b, c).
// 'DESC' - descending order from highest to lowest values (3, 2, 1; c, b, a).
'orderby' => 'date', //(string) - Sort retrieved posts by parameter. Defaults to 'date'. One or more options can be passed. EX: 'orderby' => 'menu_order title'
'orderby' => 'title author', //(string) - Order by both title & author. For more info see: http://wordpress.stackexchange.com/questions/2969/order-by-menu-order-and-title
//In 4.0, you can now pass an array value for orderby. The syntax looks like:
'orderby' => array( //(array) - Allows for an independent order value for each key. https://core.trac.wordpress.org/changeset/29027
'title' => 'DESC',
'menu_order' => 'ASC',
),
//Possible Values:
//'none' - No order (available with Version 2.8).
//'ID' - Order by post id. Note the captialization.
//'author'|'post_author' - Order by author.
//'title'|'post_title' - Order by title.
//'name'|'post_name' - Order by post name (post slug).
//'type'|'post_type' - Order by post type (available since Version 4.0). ('post_type' is also accepted.)
//'date'|'post_date' - Order by date.
//'modified'|'post_modified' - Order by last modified date.
//'parent'|'post_parent' - Order by post/page parent id.
//'rand'|'RAND(x)' - Random order. You can also use 'RAND(x)' where 'x' is an integer seed value.
//'comment_count' - Order by number of comments (available with Version 2.9).
//'relevance' - Order by search terms in the following order: First, whether the entire sentence is matched. Second, if all the search terms are within the titles. Third, if any of the search terms appear in the titles. And, fourth, if the full sentence appears in the contents.
//'menu_order' - Order by Page Order. Used most often for Pages (Order field in the EdiPage Attributes box) and for Attachments (the integer fields in the Insert / Upload MediGallery dialog), but could be used for any post type with distinct 'menu_order' values (theall default to 0).
//'meta_value' - Note that a 'meta_key=keyname' must also be present in the query. Note alsthat the sorting will be alphabetical which is fine for strings (i.e. words), but can bunexpected for numbers (e.g. 1, 3, 34, 4, 56, 6, etc, rather than 1, 3, 4, 6, 34, 56 as yomight naturally expect).
//'meta_value_num' - Order by numeric meta value (available with Version 2.8). Also notthat a 'meta_key=keyname' must also be present in the query. This value allows for numericasorting as noted above in 'meta_value'.
//'post__in' - Preserve post ID order given in the post__in array (available with Version 3.5).
//'post_name__in' - Preserve post slug order given in the 'post_name__in' array (available since Version 4.6). Note - the value of the order parameter does not change the resulting sort order.
//'post_parent__in' - Preserve post parent order given in the 'post_parent__in' array (available since Version 4.6). Note - the value of the order parameter does not change the resulting sort order.
////// DATE Parameters - Show posts associated with a certain time and date period.
//http://codex.wordpress.org/Class_Reference/WP_Query#Date_Parameters
'year' => 2014, //(int) - 4 digit year (e.g. 2011).
'monthnum' => 4, //(int) - Month number (from 1 to 12).
'w' => 25, //(int) - Week of the year (from 0 to 53). Uses the MySQL WEEK command. The mode is dependenon the "start_of_week" option.
'day' => 17, //(int) - Day of the month (from 1 to 31).
'hour' => 13, //(int) - Hour (from 0 to 23).
'minute' => 19, //(int) - Minute (from 0 to 60).
'second' => 30, //(int) - Second (0 to 60).
'm' => 201404, //(int) - YearMonth (For e.g.: 201307).
'date_query' => array( //(array) - Date parameters (available with Version 3.7).
// These are super powerful. check out the codex for more comprehensive code examples http://codex.wordpress.org/Class_Reference/WP_Query#Date_Parameters
array(
'year' => 2014, //(int) - 4 digit year (e.g. 2011).
'month' => 4 //(int) - Month number (from 1 to 12).
'week' => 31 //(int) - Week of the year (from 0 to 53).
'day' => 5 //(int) - Day of the month (from 1 to 31).
'hour' => 2 //(int) - Hour (from 0 to 23).
'minute' => 3 //(int) - Minute (from 0 to 59).
'second' => 36 //(int) - Second (0 to 59).
'after' => 'January 1st, 2013', //(string/array) - Date to retrieve posts after. Accepts strtotime()-compatible string, or array of 'year', 'month', 'day'
'before' => array( //(string/array) - Date to retrieve posts after. Accepts strtotime()-compatible string, or array of 'year', 'month', 'day'
'year' => 2013, //(string) - Accepts any four-digit year. Default is empty.
'month' => 2, //(string) - The month of the year. Accepts numbers 1-12. Default: 12.
'day' => 28, //(string) - The day of the month. Accepts numbers 1-31. Default: last day of month.
),
'inclusive' => true, //(bool) - For after/before, whether exact value should be matched or not'.
'compare' => '=', //(string) - Possible values are '=', '!=', '>', '>=', '<', '<=', 'LIKE', 'NOT LIKE', 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN', 'EXISTS' (only in WP >= 3.5), and 'NOT EXISTS' (also only in WP >= 3.5). Default value is '='
'column' => 'post_date', //(string) - Column to query against. Default: 'post_date'.
'relation' => 'AND', //(string) - OR or AND, how the sub-arrays should be compared. Default: AND.
),
),
////// CUSTOM FIELD (Post Meta) Parameters - Show posts associated with a certain custom field.
//http://codex.wordpress.org/Class_Reference/WP_Query#Custom_Field_Parameters
'meta_key' => 'key', //(string) - Custom field key.
'meta_value' => 'value', //(string) - Custom field value.
'meta_value_num' => 10, //(int) - Custom field value.
'meta_compare' => '=', //(string) - Operator to test the 'meta_value'. Possible values are '!=', '>', '>=', '<', or ='. Default value is '='.
//Possible Values: Default value is '='
//'=', '!=', '>', '>=', '<', '<=', 'LIKE', 'NOT LIKE', 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN', 'EXISTS' (WP >= 3.5), and 'NOT EXISTS' (WP >= 3.5).
'meta_query' => array( //(array) - Custom field parameters (available with Version 3.1).
'relation' => 'AND', //(string) - Possible values are 'AND', 'OR'. The logical relationship between each inner meta_query array when there is more than one.
// Do not use with a single inner meta_query array.
array(
'key' => 'color', //(string) - Custom field key.
'value' => 'blue', //(string/array) - Custom field value (Note: Array support is limited to a compare value of 'IN', 'NOT IN', 'BETWEEN', or 'NOT BETWEEN') Using WP < 3.9? Check out this page for details: http://codex.wordpress.org/Class_Reference/WP_Query#Custom_Field_Parameters
'compare' => '=', //(string) - Operator to test.
//Possible values: Default value is '='.
//'=', '!=', '>', '>=', '<', '<=', 'LIKE', 'NOT LIKE', 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN', 'EXISTS' (WP >= 3.5), and 'NOT EXISTS' (WP >= 3.5).
'type' => 'CHAR', //(string) - Custom field type. The 'type' DATE works with the 'compare' value BETWEEN only if the date is stored at the format YYYYMMDD and tested with this format.
//Possible values: Default value is 'CHAR'.
//'NUMERIC', 'BINARY', 'CHAR', 'DATE', 'DATETIME', 'DECIMAL', 'SIGNED', 'TIME', 'UNSIGNED'.
),
array(
'key' => 'price',
'value' => array( 1,200 ),
'compare' => 'NOT LIKE'
)
),
////// PERMISSIONS Parameters - Display published posts, as well as private posts, if the user has the appropriate capability:
//http://codex.wordpress.org/Class_Reference/WP_Query#Permission_Parameters
'perm' => 'readable' //(string) Possible values are 'readable', 'editable'
////// MIME TYPE Parameters
//https://codex.wordpress.org/Class_Reference/WP_Query#Mime_Type_Parameters
//https://developer.wordpress.org/reference/classes/wp_query/#mime-type-parameters
//NOTE: Used with the attachments post type.
'post_mime_type' => 'image/gif', //(string/array) – Allowed mime types.
////// CACHE Parameters
//http://codex.wordpress.org/Class_Reference/WP_Query#Caching_Parameters
//NOTE Caching is a good thing. Setting these to false is generally not advised.
'cache_results' => true, //(bool) - Post information cache. Default: true.
'update_post_term_cache' => true, //(bool) - Post meta information cache. Default: true.
'update_post_meta_cache' => true, //(bool) - Post term information cache. Default: true.
'no_found_rows' => false, //(bool) WordPress uses SQL_CALC_FOUND_ROWS in most queries in order to implement pagination.
// Even when you don’t need pagination at all. By Setting this parameter to true you are
// telling wordPress not to count the total rows and reducing load on the DB. Pagination
// will NOT WORK when this parameter is set to true.
// For more information see: http://flavio.tordini.org/speed-up-wordpress-get_posts-and-query_posts-functions
////// RETURN FIELDS Parameters
//For more info see: http://codex.wordpress.org/Class_Reference/WP_Query#Return_Fields_Parameter
//also https://gist.github.com/luetkemj/2023628/#comment-1003542
'fields' => 'ids', //(string) - Which fields to return. All fields are returned by default.
// Possible values:
// 'all' - Return all fields (default).
// 'ids' - Return an array of post IDs.
// 'id=>parent' - Return an associative array [ parent => ID, … ].
// Passing anything else will return all fields (default) - an array of post objects.
//////Filters
//For more information on available Filters see: http://codex.wordpress.org/Class_Reference/WP_Query#Filters
////// Others/Misc
'suppress_filters' => false, // (bool) true, any filters attached to pre_get_posts are still applied—only filters attached on 'posts_*' or 'comment_feed_*' are suppressed.
);
$the_query = new WP_Query( $args );
// The Loop
if ( $the_query->have_posts() ) :
while ( $the_query->have_posts() ) : $the_query->the_post();
// Do Stuff
endwhile;
endif;
// Reset Post Data
wp_reset_postdata();
?>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment