wp_get_recent_posts() WordPress Function
The wp_get_recent_posts() function is a quick way to get an array of the most recent posts. You can specify how many posts to retrieve, and what type of posts to include.
wp_get_recent_posts( array $args = array(), string $output = ARRAY_A ) #
Retrieve a number of recent posts.
Description
See also
Parameters
- $args
(array)(Optional) Arguments to retrieve posts.
Default value: array()
- $output
(string)(Optional) The required return type. One of OBJECT or ARRAY_A, which correspond to a WP_Post object or an associative array, respectively.
Default value: ARRAY_A
Return
(array|false) Array of recent posts, where the type of each element is determined by the $output
parameter. Empty array on failure.
More Information
Only the value of ARRAY_A is checked for $output. Any other value or constant passed will return an array of objects.
This function returns posts in an associative array (ARRAY_A) format which is compatible with WordPress versions below 3.1.
To get output similar to get_posts(), use OBJECT as the second parameter: wp_get_recent_posts( $args, OBJECT );
Source
File: wp-includes/post.php
function wp_get_recent_posts( $args = array(), $output = ARRAY_A ) { if ( is_numeric( $args ) ) { _deprecated_argument( __FUNCTION__, '3.1.0', __( 'Passing an integer number of posts is deprecated. Pass an array of arguments instead.' ) ); $args = array( 'numberposts' => absint( $args ) ); } // Set default arguments. $defaults = array( 'numberposts' => 10, 'offset' => 0, 'category' => 0, 'orderby' => 'post_date', 'order' => 'DESC', 'include' => '', 'exclude' => '', 'meta_key' => '', 'meta_value' => '', 'post_type' => 'post', 'post_status' => 'draft, publish, future, pending, private', 'suppress_filters' => true, ); $parsed_args = wp_parse_args( $args, $defaults ); $results = get_posts( $parsed_args ); // Backward compatibility. Prior to 3.1 expected posts to be returned in array. if ( ARRAY_A === $output ) { foreach ( $results as $key => $result ) { $results[ $key ] = get_object_vars( $result ); } return $results ? $results : array(); } return $results ? $results : false; }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
1.0.0 | Introduced. |