Changeset 25266

Timestamp:

09/05/2013 10:12:17 PM (12 years ago)

Author:

wonderboymusic

Message:

Add docs to the woefully under-documented get_pages().

Props DrewAPicture.
Fixes #25186.

File:

• trunk/src/wp-includes/post.php (modified) (1 diff)

trunk/src/wp-includes/post.php

@@ -3618 +3618 @@
  * 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
  */