From 1855f97a2cc11e482a3e3b323e6e3de8264c25b6 Mon Sep 17 00:00:00 2001 From: Scott Taylor Date: Thu, 5 Sep 2013 22:13:09 +0000 Subject: [PATCH] Add docs to the woefully under-documented `get_pages()`. Props DrewAPicture. Fixes #25186. Built from https://develop.svn.wordpress.org/trunk@25266 git-svn-id: http://core.svn.wordpress.org/trunk@25232 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-includes/post.php | 23 ++++++++++++++++++----- 1 file changed, 18 insertions(+), 5 deletions(-) diff --git a/wp-includes/post.php b/wp-includes/post.php index c478d7c961..dc30f73ba4 100644 --- a/wp-includes/post.php +++ b/wp-includes/post.php @@ -3617,14 +3617,27 @@ function get_page_uri( $page ) { /** * Retrieve a list of pages. * - * The defaults that can be overridden are the following: 'child_of', - * 'sort_order', 'sort_column', 'post_title', 'hierarchical', 'exclude', - * 'include', 'meta_key', 'meta_value','authors', 'number', and 'offset'. + * @global wpdb $wpdb WordPress database abstraction object * * @since 1.5.0 - * @uses $wpdb * - * @param mixed $args Optional. Array or string of options that overrides defaults. + * @param mixed $args (optional) Array or string of arguments { + * @type int 'child_of' Page ID to return child and grandchild pages of (default 0). + * @type string 'sort_order' How to sort retrieved pages (default 'ASC', accepts 'ASC', 'DESC'). + * @type string 'sort_column' What column to sort pages by (default 'post_title', accepts post fields). + * @type bool 'hierarchical' Whether to return pages hierarchically (default 1|true). + * @type array 'exclude' Array of page IDs to exclude (default array). + * @type array 'include' Array of page IDs to include (default array). + * @type string 'meta_key' Only include pages with this meta key (default empty). + * @type string 'meta_value' Only include pages with this meta value (default empty). + * @type string 'authors' A comma-separated list of author IDs (default empty). + * @type int 'parent' Page ID to return direct children of. 'hierarchical' must be 0|false (default -1). + * @type int 'exclude_tree' Remove all children of given ID from returned pages (default empty). + * @type int 'number' The number of pages to return (default empty). + * @type int 'offset' The number of pages to skip before returning (default 0). + * @type string 'post_type' The post type to return (default 'page'). + * @type string 'post_status' A comma-separated list of post status types to include (default 'publish'). + * } * @return array List of pages matching defaults or $args */ function get_pages($args = '') {