get_pages( array|string $args = array() ): WP_Post[]|false

Parameters

$argsarray|stringoptional

Array or string of arguments to retrieve pages.Default: array()

• $child_ofintdefault: 0, or no restriction

  Page ID to return child and grandchild pages of. Note: The value of $hierarchical has no bearing on whether $child_of returns hierarchical results.

• $sort_orderstringdefault: 'ASC'

  How to sort retrieved pages. Accepts 'ASC', 'DESC'.

• $sort_columnstringdefault: 'post_title'

  What columns to sort pages by, comma-separated. Accepts 'post_author', 'post_date', 'post_title', 'post_name', 'post_modified', 'menu_order', 'post_modified_gmt', 'post_parent', 'ID', 'rand', 'comment<em>count'. 'post</em>' can be omitted for any values that start with it.

• $hierarchicalbooldefault: true

  Whether to return pages hierarchically. If false in conjunction with $child_of also being false, both arguments will be disregarded.

• $excludeint[]default: empty array

  Array of page IDs to exclude.

• $includeint[]default: empty array

  Array of page IDs to include. Cannot be used with $child_of, $parent, $exclude, $meta_key, $meta_value, or $hierarchical.

• $meta_keystringdefault: empty

  Only include pages with this meta key.

• $meta_valuestringdefault: empty

  Only include pages with this meta value. Requires $meta_key.

• $authorsstringdefault: empty

  A comma-separated list of author IDs.

• $parentintdefault: -1, or no restriction

  Page ID to return direct children of.

• $exclude_treestring|int[]default: empty array

  Comma-separated string or array of page IDs to exclude.

• $numberintdefault: 0, or all pages

  The number of pages to return.

• $offsetintdefault: 0

  The number of pages to skip before returning. Requires $number.

• $post_typestringdefault: 'page'

  The post type to query.

• $post_statusstring|arraydefault: 'publish'

  A comma-separated list or array of post statuses to include.

Return

WP_Post[]|false

Array of pages (or hierarchical post type items). Boolean false if the specified post type is not hierarchical or the specified status is not supported by the post type.

Hooks fired · 2

2 hooks fire while get_pages() runs, in this order:

1. 1
   apply_filters( get_pages_query_args )filterline 6415 (+141 into the body)

   Filters query arguments passed to WP_Query in get_pages.

2. 2
   apply_filters( get_pages )filterline 6449 (+175 into the body)

   Filters the retrieved list of pages.

Uses · 9

• wp_parse_args()Merges user defined arguments into defaults array.
• get_post_types()Gets a list of all registered post type objects.
• get_post_stati()Gets a list of post statuses.
• wp_parse_id_list()Cleans up an array, comma- or space-separated list of IDs.
• wp_parse_list()Converts a comma- or space-separated list of scalar values to an array.
• get_user_by()Retrieves user info by a given field.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• get_page_children()Identifies descendants of a given page ID in a list of page objects.
• WP_Query::__construct()Constructor.

Used by · 7

• WP_Customize_Manager::has_published_pages()Returns whether there are published pages.
• WP_Navigation_Block_Renderer::has_submenus()Returns whether or not a navigation has a submenu.
• WP_Posts_List_Table::_display_rows_hierarchical()
• get_body_class()Retrieves an array of the class names for the body element.
• render_block_core_page_list()Renders the `core/page-list` block on server.
• wp_dropdown_pages()Retrieves or displays a list of pages as a dropdown (select list).
• wp_list_pages()Retrieves or displays a list of pages (or hierarchical post type items) in list (li) format.

Source

View on Trac ↗View on GitHub ↗

6274function get_pages( $args = array() ) {6275	$defaults = array(6276		'child_of'     => 0,6277		'sort_order'   => 'ASC',6278		'sort_column'  => 'post_title',6279		'hierarchical' => 1,6280		'exclude'      => array(),6281		'include'      => array(),6282		'meta_key'     => '',6283		'meta_value'   => '',6284		'authors'      => '',6285		'parent'       => -1,6286		'exclude_tree' => array(),6287		'number'       => '',6288		'offset'       => 0,6289		'post_type'    => 'page',6290		'post_status'  => 'publish',6291	);6292 6293	$parsed_args = wp_parse_args( $args, $defaults );6294 6295	$number       = (int) $parsed_args['number'];6296	$offset       = (int) $parsed_args['offset'];6297	$child_of     = (int) $parsed_args['child_of'];6298	$hierarchical = $parsed_args['hierarchical'];6299	$exclude      = $parsed_args['exclude'];6300	$meta_key     = $parsed_args['meta_key'];6301	$meta_value   = $parsed_args['meta_value'];6302	$parent       = $parsed_args['parent'];6303	$post_status  = $parsed_args['post_status'];6304 6305	// Make sure the post type is hierarchical.6306	$hierarchical_post_types = get_post_types( array( 'hierarchical' => true ) );6307	if ( ! in_array( $parsed_args['post_type'], $hierarchical_post_types, true ) ) {6308		return false;6309	}6310 6311	if ( $parent > 0 && ! $child_of ) {6312		$hierarchical = false;6313	}6314 6315	// Make sure we have a valid post status.6316	if ( ! is_array( $post_status ) ) {6317		$post_status = explode( ',', $post_status );6318	}6319	if ( array_diff( $post_status, get_post_stati() ) ) {6320		return false;6321	}6322 6323	$query_args = array(6324		'orderby'                => 'post_title',6325		'order'                  => 'ASC',6326		'post__not_in'           => wp_parse_id_list( $exclude ),6327		'meta_key'               => $meta_key,6328		'meta_value'             => $meta_value,6329		'posts_per_page'         => -1,6330		'offset'                 => $offset,6331		'post_type'              => $parsed_args['post_type'],6332		'post_status'            => $post_status,6333		'update_post_term_cache' => false,6334		'update_post_meta_cache' => false,6335		'ignore_sticky_posts'    => true,6336		'no_found_rows'          => true,6337	);6338 6339	if ( ! empty( $parsed_args['include'] ) ) {6340		$child_of = 0; // Ignore child_of, parent, exclude, meta_key, and meta_value params if using include.6341		$parent   = -1;6342		unset( $query_args['post__not_in'], $query_args['meta_key'], $query_args['meta_value'] );6343		$hierarchical           = false;6344		$query_args['post__in'] = wp_parse_id_list( $parsed_args['include'] );6345	}6346 6347	if ( ! empty( $parsed_args['authors'] ) ) {6348		$post_authors = wp_parse_list( $parsed_args['authors'] );6349 6350		if ( ! empty( $post_authors ) ) {6351			$query_args['author__in'] = array();6352			foreach ( $post_authors as $post_author ) {6353				// Do we have an author id or an author login?

History

Introduced in 1.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/post.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.