get_posts( array $args = null ): WP_Post[]|int[]
Retrieves an array of the latest posts, or posts matching the given criteria.
Contents
Description
For more information on the accepted arguments, see the WP_Query documentation in the Developer Handbook.
The $ignore_sticky_posts
and $no_found_rows
arguments are ignored by this function and both are set to true
.
The defaults are as follows:
See also
Parameters
-
$args
array Optional -
Arguments to retrieve posts. See WP_Query::parse_query() for all available arguments.
numberposts
intTotal number of posts to retrieve. Is an alias of$posts_per_page
in WP_Query. Accepts -1 for all. Default 5.category
int|stringCategory ID or comma-separated list of IDs (this or any children).
Is an alias of$cat
in WP_Query. Default 0.include
int[]An array of post IDs to retrieve, sticky posts will be included.
Is an alias of$post__in
in WP_Query. Default empty array.exclude
int[]An array of post IDs not to retrieve. Default empty array.suppress_filters
boolWhether to suppress filters. Default true.
More Arguments from WP_Query::parse_query( ... $query )
Array or string of Query parameters.
attachment_id
intAttachment post ID. Used for'attachment'
post_type.author
int|stringAuthor ID, or comma-separated list of IDs.author_name
stringUser'user_nicename'
.author__in
int[]An array of author IDs to query from.author__not_in
int[]An array of author IDs not to query from.cache_results
boolWhether to cache post information. Default true.cat
int|stringCategory ID or comma-separated list of IDs (this or any children).category__and
int[]An array of category IDs (AND in).category__in
int[]An array of category IDs (OR in, no children).category__not_in
int[]An array of category IDs (NOT in).category_name
stringUse category slug (not name, this or any children).comment_count
array|intFilter 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.comment_status
stringComment status.comments_per_page
intThe number of comments to return per page.
Default'comments_per_page'
option.date_query
arrayday
intDay of the month. Accepts numbers 1-31.exact
boolWhether to search by exact keyword. Default false.fields
stringPost 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[]
).
''
.hour
intHour of the day. Accepts numbers 0-23.ignore_sticky_posts
int|boolWhether to ignore sticky posts or not. Setting this to false excludes stickies from'post__in'
. Accepts1|true
,0|false
.
Default false.m
intCombination YearMonth. Accepts any four-digit year and month numbers 01-12.meta_key
string|string[]Meta key or keys to filter by.meta_value
string|string[]Meta value or values to filter by.meta_compare
stringMySQL operator used for comparing the meta value.
See WP_Meta_Query::__construct() for accepted values and default value.meta_compare_key
stringMySQL operator used for comparing the meta key.
See WP_Meta_Query::__construct() for accepted values and default value.meta_type
stringMySQL data type that the meta_value column will be CAST to for comparisons.
See WP_Meta_Query::__construct() for accepted values and default value.meta_type_key
stringMySQL data type that the meta_key column will be CAST to for comparisons.
See WP_Meta_Query::__construct() for accepted values and default value.meta_query
arrayAn associative array of WP_Meta_Query arguments.
See WP_Meta_Query::__construct() for accepted values.menu_order
intThe menu order of the posts.minute
intMinute of the hour. Accepts numbers 0-59.monthnum
intThe two-digit month. Accepts numbers 1-12.name
stringPost slug.nopaging
boolShow all posts (true) or paginate (false). Default false.no_found_rows
boolWhether to skip counting the total rows found. Enabling can improve performance. Default false.offset
intThe number of posts to offset before retrieval.order
stringDesignates ascending or descending order of posts. Default'DESC'
.
Accepts'ASC'
,'DESC'
.orderby
string|arraySort 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
.
'date'
, except when a search is being performed, when the default is'relevance'
.p
intPost ID.page
intShow the number of posts that would show up on page X of a static front page.paged
intThe number of the current page.page_id
intPage ID.pagename
stringPage slug.perm
stringShow posts if user has the appropriate capability.ping_status
stringPing status.post__in
int[]An array of post IDs to retrieve, sticky posts will be included.post__not_in
int[]An array of post IDs not to retrieve. Note: a string of comma- separated IDs will NOT work.post_mime_type
stringThe mime type of the post. Used for'attachment'
post_type.post_name__in
string[]An array of post slugs that results must match.post_parent
intPage ID to retrieve child pages for. Use 0 to only retrieve top-level pages.post_parent__in
int[]An array containing parent page IDs to query child pages from.post_parent__not_in
int[]An array containing parent page IDs not to query child pages from.post_type
string|string[]A post type slug (string) or array of post type slugs.
Default'any'
if using'tax_query'
.post_status
string|string[]A post status (string) or array of post statuses.posts_per_page
intThe number of posts to query for. Use -1 to request all posts.posts_per_archive_page
intThe number of posts to query for by archive page. Overrides'posts_per_page'
when is_archive() , or is_search() are true.s
stringSearch 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.search_columns
string[]Array of column names to be searched. Accepts'post_title'
,'post_excerpt'
and'post_content'
. Default empty array.second
intSecond of the minute. Accepts numbers 0-59.sentence
boolWhether to search by phrase. Default false.suppress_filters
boolWhether to suppress filters. Default false.tag
stringTag slug. Comma-separated (either), Plus-separated (all).tag__and
int[]An array of tag IDs (AND in).tag__in
int[]An array of tag IDs (OR in).tag__not_in
int[]An array of tag IDs (NOT in).tag_id
intTag id or comma-separated list of IDs.tag_slug__and
string[]An array of tag slugs (AND in).tag_slug__in
string[]An array of tag slugs (OR in). unless'ignore_sticky_posts'
is true. Note: a string of comma-separated IDs will NOT work.tax_query
arraytitle
stringPost title.update_post_meta_cache
boolWhether to update the post meta cache. Default true.update_post_term_cache
boolWhether to update the post term cache. Default true.update_menu_item_cache
boolWhether to update the menu item cache. Default false.lazy_load_term_meta
boolWhether 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
.w
intThe week number of the year. Accepts numbers 0-53.year
intThe four-digit year. Accepts any four-digit year.
Default:
null
Return
WP_Post[]|int[] Array of post objects or post IDs.
More Information
The most appropriate use for get_posts is to create an array of posts based on a set of parameters. It retrieves a list of recent posts or posts matching this criteria. get_posts can also be used to create Multiple Loops, though a more direct reference to WP_Query using new WP_Query is preferred in this case.
The parameters of get_posts are similar to those of get_pages but are implemented quite differently, and should be used in appropriate scenarios. get_posts uses WP_Query, whereas get_pages queries the database more directly. Each have parameters that reflect this difference in implementation.
query_posts also uses WP_Query, but is not recommended because it directly alters the main loop by changing the variables of the global variable $wp_query. get_posts, on the other hand, simply references a new WP_Query object, and therefore does not affect or alter the main loop.
If you would like to alter the main query before it is executed, you can hook into it using pre_get_posts. If you would just like to call an array of posts based on a small and simple set of parameters within a page, then get_posts is your best option.
Source
File: wp-includes/post.php
.
View all references
function get_posts( $args = null ) {
$defaults = array(
'numberposts' => 5,
'category' => 0,
'orderby' => 'date',
'order' => 'DESC',
'include' => array(),
'exclude' => array(),
'meta_key' => '',
'meta_value' => '',
'post_type' => 'post',
'suppress_filters' => true,
);
$parsed_args = wp_parse_args( $args, $defaults );
if ( empty( $parsed_args['post_status'] ) ) {
$parsed_args['post_status'] = ( 'attachment' === $parsed_args['post_type'] ) ? 'inherit' : 'publish';
}
if ( ! empty( $parsed_args['numberposts'] ) && empty( $parsed_args['posts_per_page'] ) ) {
$parsed_args['posts_per_page'] = $parsed_args['numberposts'];
}
if ( ! empty( $parsed_args['category'] ) ) {
$parsed_args['cat'] = $parsed_args['category'];
}
if ( ! empty( $parsed_args['include'] ) ) {
$incposts = wp_parse_id_list( $parsed_args['include'] );
$parsed_args['posts_per_page'] = count( $incposts ); // Only the number of posts included.
$parsed_args['post__in'] = $incposts;
} elseif ( ! empty( $parsed_args['exclude'] ) ) {
$parsed_args['post__not_in'] = wp_parse_id_list( $parsed_args['exclude'] );
}
$parsed_args['ignore_sticky_posts'] = true;
$parsed_args['no_found_rows'] = true;
$get_posts = new WP_Query();
return $get_posts->query( $parsed_args );
}
Changelog
Version | Description |
---|---|
1.2.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.
Returns an array of WP_Post objects with attributes,
Array of post IDs
To return ids instead of post objects use the
fields
argument.The
fields
argument can be set to'ids'
,'all'
(default) or'id=>parent'
. The last two (arguments) will return an array of stdClass objects.Source:
https://developer.wordpress.org/reference/classes/wp_query/#return-fields-parameter
Example to get the latest 10 posts in the blog:
You can also pass the
post_type
argument if you want to get posts from a Custom Post Type, like:Custom Field Parameters
Show posts associated with a certain custom field. Following example displays posts from the ‘product’ post type that have meta key ‘featured’ with value ‘yes’, using ‘meta_query’:
Refer to the custom fields parameters section of the WP_Query documentation for more examples.
Posts with Previous Next Navigation
You can also using the custom queries to make the post with Previous and Next Post Navigation. Here is the following method to make it workable.
Reset after Postlists with offset
If you need after the loop, the post you had before joining the foreach, you can use this:
Access all post data
Some post-related data is not available to get_posts by default, such as post content through the_content(), or the numeric ID. This is resolved by calling an internal function setup_postdata(), with the $post array as its argument:
To access a post’s ID or content without calling setup_postdata(), or in fact any post-specific data (data retained in the posts table), you can use $post->COLUMN, where COLUMN is the table column name for the data. So $post->ID holds the ID, $post->post_content the content, and so on. To display or print this data on your page use the PHP echo command, like so:
Taxonomy Parameters
Show posts associated with certain taxonomy. If specifying a taxonomy registered to a custom post type then instead of using ‘category’ you would use ‘{custom_taxonomy_name}’. For instance, if you had a custom taxonomy called “genre” and wanted to only show posts from the “jazz” genre you would use the below code.
Following example displays posts tagged with ‘jazz’, under ‘genre’ custom taxonomy, using ‘tax_query’:
Refer to the taxonomy parameters section of the WP_Query documentation for more examples.
Get all published posts of ANY post type:
Get a post by its slug
Allows you to get a post ID by post slug.
orderby
also accepts the valuepost__in
. (Note two underscores between post and in.) If you usedinclude
to retrieve specific posts, the posts will be supplied in the order you supplied to include. For example:You can check all the parameters that can be used on
get_posts
on https://codex.wordpress.org/Class_Reference/WP_Query#ParametersShow all attachments
Do this outside any Loops in your template.
It is not considered an error condition if no posts are found based on the specified and default parameter values. Instead, an empty array (“
array()
“) is returned by the function.Example to display posts or post type ‘album’, tagged with ‘jazz’ or ‘improv’ under the ‘genre’ custom taxonomy:
Note that the simple
'{custom_taxonomy_name}' => 'jazz'
has been deprecated in favor oftax_query
. More complex examples can be found on https://codex.wordpress.org/Class_Reference/WP_Query#Taxonomy_ParametersLatest posts ordered by title
To show the last ten posts sorted alphabetically in ascending order, the following will display their post date, title and excerpt:
Random posts
Display a list of 5 posts selected randomly by using the MySQL RAND() function for the orderby parameter value:
Show attachments for the current post
Do this inside The Loop (where $post->ID is available).
Order results by post types names
If you have an array of custom post types you can also order the results by post_type name, this works if you need to “group” the results.
To Find Post By Title
To find a post by its title the array key is ‘title’, NOT ‘post_title’:
Only Published Posts Will Be Found Unless Status Specified
If you are searching for a post that is in draft, private, etc status and not in publish status, get_posts will not find your post unless you include the post_status in the array.
If you use
any
as thepost_status
, it will return all post_status except fortrash
andauto-draft
.Posts list with offset
If you have your blog configured to show just one post on the front page, but also want to list links to the previous five posts in category ID 1, you can use this:
Note: With use of the offset, the above query should be used only on a category that has more than one post in it, otherwise there’ll be no output.