get_posts() WP 1.0

Retrieve list of latest posts or posts matching criteria.

The defaults are as follows:

No Hooks.

Return

WP_Post[]/Int[]. Array of post objects or post IDs.

Usage

get_posts( $args );

$args(array)

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_page in 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 $cat in WP_Query.

• $include (array)
  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 (array)
  An array of post IDs not to retrieve.
  Default: empty array

• $suppress_filters (true/false)
  Whether to suppress filters.
  Default: true

Default: null

Notes

• See: WP_Query::parse_query()

Changelog

Code of get posts: wp-includes/post.php ^{WP 5.4.2}

<?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 );

}

Related Functions

From tag: query

More from category: Queries