get_posts( array $args = null )

Retrieve list of latest posts or posts matching criteria.

Description

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_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. Default 0.
  • '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'
    (bool) Whether to suppress filters. Default true.

Default value: null

Return

(array) List of posts.

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

	$r = wp_parse_args( $args, $defaults );
	if ( empty( $r['post_status'] ) )
		$r['post_status'] = ( 'attachment' == $r['post_type'] ) ? 'inherit' : 'publish';
	if ( ! empty($r['numberposts']) && empty($r['posts_per_page']) )
		$r['posts_per_page'] = $r['numberposts'];
	if ( ! empty($r['category']) )
		$r['cat'] = $r['category'];
	if ( ! empty($r['include']) ) {
		$incposts = wp_parse_id_list( $r['include'] );
		$r['posts_per_page'] = count($incposts);  // only the number of posts included
		$r['post__in'] = $incposts;
	} elseif ( ! empty($r['exclude']) )
		$r['post__not_in'] = wp_parse_id_list( $r['exclude'] );

	$r['ignore_sticky_posts'] = true;
	$r['no_found_rows'] = true;

	$get_posts = new WP_Query;
	return $get_posts->query($r);

}

Expand Source Code View on GitHub

Related

Uses

Uses
Uses Description
wp-includes/class-wp-query.php: WP_Query::__construct()

Constructor.
wp-includes/functions.php: wp_parse_args()

Merge user defined arguments into defaults array.
wp-includes/functions.php: wp_parse_id_list()

Clean up an array, comma- or space-separated list of IDs.

Used By

Used By
Used By Description
wp-includes/media.php: gallery_shortcode()

Builds the Gallery shortcode output.
wp-includes/media.php: wp_playlist_shortcode()

Builds the Playlist shortcode output.
wp-includes/class-wp-query.php: WP_Query::get_posts()

Retrieve the posts based on query variables.
wp-includes/nav-menu.php: wp_get_nav_menu_items()

Retrieves all menu items of a navigation menu.
wp-includes/link-template.php: get_boundary_post()

Retrieves the boundary post.
wp-includes/theme.php: get_uploaded_header_images()

Get the header images uploaded for the current theme.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_getMediaLibrary()

Retrieves a collection of media library items (or attachments)
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_getPages()

Retrieve Pages.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::get_changeset_posts()

Get changeset posts.
wp-includes/post.php: wp_add_trashed_suffix_to_post_name_for_trashed_posts()

Adds a suffix if any trashed posts have a given slug.
wp-includes/post.php: wp_get_recent_posts()

Retrieve a number of recent posts.
wp-includes/post.php: get_children()

Retrieve all children of the post parent ID.
wp-includes/class-wp-customize-nav-menus.php: WP_Customize_Nav_Menus::load_available_items_query()

Performs the post_type and taxonomy queries for loading available menu items.
wp-admin/includes/image.php: wp_generate_attachment_metadata()

Generate post thumbnail attachment meta data.
wp-admin/includes/nav-menu.php: wp_nav_menu_item_post_type_meta_box()

Displays a meta box for a post type menu item.
wp-admin/includes/ajax-actions.php: wp_ajax_find_posts()

Ajax handler for querying posts for the Find Posts modal.
wp-admin/includes/dashboard.php: wp_dashboard_recent_drafts()

Show recent drafts of the user on the dashboard.
Show 12 more used by Hide more used by

Changelog

Changelog
Version Description
WP-1.2.0 Introduced.