From 0fee97e110b22508b957b8f844bb1333d73922ef Mon Sep 17 00:00:00 2001 From: "Drew Jaynes (DrewAPicture)" Date: Wed, 3 Dec 2014 10:15:08 +0000 Subject: [PATCH] Use the correct hash notation syntax for the `get_pages()` DocBlock. See #28298. git-svn-id: https://develop.svn.wordpress.org/trunk@30723 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/post.php | 52 ++++++++++++++++++++-------------------- 1 file changed, 26 insertions(+), 26 deletions(-) diff --git a/src/wp-includes/post.php b/src/wp-includes/post.php index 96f0120ab4..23685619a2 100644 --- a/src/wp-includes/post.php +++ b/src/wp-includes/post.php @@ -4389,33 +4389,33 @@ function get_page_uri( $page ) { * * @since 1.5.0 * - * @param mixed $args { - * Array or string of arguments. Optional. + * @param array|string $args { + * Optional. Array or string of arguments to retrieve pages. * - * @type int 'child_of' Page ID to return child and grandchild pages of. Default 0, or no restriction. - * @type string 'sort_order' How to sort retrieved pages. - * Default 'ASC'. Accepts 'ASC', 'DESC'. - * @type string 'sort_column' What columns to sort pages by, comma-separated. - * Default 'post_title'. Accepts 'post_author', 'post_date', 'post_title', 'post_name', - * 'post_modified', 'post_modified_gmt', 'menu_order', 'post_parent', 'ID', 'rand', - * 'comment_count'. 'post_' can be omitted for any values that start with it. - * @type bool 'hierarchical' Whether to return pages hierarchically. Default true. - * @type array 'exclude' Array of page IDs to exclude. - * @type array 'include' Array of page IDs to include. Cannot be used with 'child_of', 'parent', 'exclude', - * 'meta_key', 'meta_value', or 'hierarchical'. - * @type string 'meta_key' Only include pages with this meta key. - * @type string 'meta_value' Only include pages with this meta value. - * @type string 'authors' A comma-separated list of author IDs. - * @type int 'parent' Page ID to return direct children of. 'hierarchical' must be false. - * Default -1, or no restriction. - * @type int 'exclude_tree' Remove all children of the given ID from returned pages. - * @type int 'number' The number of pages to return. Default 0, or all pages. - * @type int 'offset' The number of pages to skip before returning. Requires 'number'. - * Default 0. - * @type string 'post_type' The post type to query. - * Default 'page'. - * @type string 'post_status' A comma-separated list of post status types to include. - * Default 'publish'. + * @type int $child_of Page ID to return child and grandchild pages of. Default 0, or no restriction. + * @type string $sort_order How to sort retrieved pages. + * Default 'ASC'. Accepts 'ASC', 'DESC'. + * @type string $sort_column What columns to sort pages by, comma-separated. + * Default 'post_title'. Accepts 'post_author', 'post_date', 'post_title', 'post_name', + * 'post_modified', 'post_modified_gmt', 'menu_order', 'post_parent', 'ID', 'rand', + * 'comment_count'. 'post_' can be omitted for any values that start with it. + * @type bool $hierarchical Whether to return pages hierarchically. Default true. + * @type array $exclude Array of page IDs to exclude. + * @type array $include Array of page IDs to include. Cannot be used with 'child_of', 'parent', 'exclude', + * 'meta_key', 'meta_value', or 'hierarchical'. + * @type string $meta_key Only include pages with this meta key. + * @type string $meta_value Only include pages with this meta value. + * @type string $authors A comma-separated list of author IDs. + * @type int $parent Page ID to return direct children of. 'hierarchical' must be false. + * Default -1, or no restriction. + * @type int $exclude_tree Remove all children of the given ID from returned pages. + * @type int $number The number of pages to return. Default 0, or all pages. + * @type int $offset The number of pages to skip before returning. Requires 'number'. + * Default 0. + * @type string $post_type The post type to query. + * 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. */