get_posts() WordPress Function
The get_posts() function is a powerful tool for retrieving posts from the WordPress database. It can be used to fetch a single post, or a set of posts based on various criteria. The function can be customized to return specific fields, and can be used in conjunction with other WordPress functions to create sophisticated custom queries.
get_posts( array $args = null ) #
Retrieves an array of the latest posts, or posts matching the given criteria.
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'
(int) Total number of posts to retrieve. Is an alias of$posts_per_pagein WP_Query. Accepts -1 for all. Default 5. - 'category'
(int|string) Category ID or comma-separated list of IDs (this or any children). Is an alias of$catin WP_Query. Default 0. - 'include'
(int[]) An array of post IDs to retrieve, sticky posts will be included. Is an alias of$post__inin WP_Query. Default empty array. - 'exclude'
(int[]) An array of post IDs not to retrieve. Default empty array. - 'suppress_filters'
(bool) Whether to suppress filters. Default true.
Default value: null
- 'numberposts'
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
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 );
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 1.2.0 | Introduced. |