Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2025-01-03 15:08:10 +01:00
Code Issues Projects Releases Wiki Activity

Docs: In get_pages() and wp_list_pages(), note that post_status argument can also be an array.

Browse Source 
Adjust the alignment of default argument values for better readability.

Props birgire, desrosj.
Fixes #38136.
Built from https://develop.svn.wordpress.org/trunk@38798


git-svn-id: http://core.svn.wordpress.org/trunk@38741 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov 2016-10-16 01:10:31 +00:00
parent d91da52588
commit 4a95bfa4c2
3 changed files with 54 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
wp-includes/post-template.php
View File

@ -1134,40 +1134,48 @@ function wp_dropdown_pages( $args = '' ) {
* @param array|string $args { * @param array|string $args {
* Array or string of arguments. Optional. * Array or string of arguments. Optional.
* *
* @type int $child_of Display only the sub-pages of a single page by ID. Default 0 (all pages). * @type int $child_of Display only the sub-pages of a single page by ID. Default 0 (all pages).
* @type string $authors Comma-separated list of author IDs. Default empty (all authors). * @type string $authors Comma-separated list of author IDs. Default empty (all authors).
* @type string $date_format PHP date format to use for the listed pages. Relies on the 'show_date' parameter. * @type string $date_format PHP date format to use for the listed pages. Relies on the 'show_date' parameter.
* Default is the value of 'date_format' option. * Default is the value of 'date_format' option.
* @type int $depth Number of levels in the hierarchy of pages to include in the generated list. * @type int $depth Number of levels in the hierarchy of pages to include in the generated list.
* Accepts -1 (any depth), 0 (all pages), 1 (top-level pages only), and n (pages to * Accepts -1 (any depth), 0 (all pages), 1 (top-level pages only), and n (pages to
* the given n depth). Default 0. * the given n depth). Default 0.
* @type bool $echo Whether or not to echo the list of pages. Default true. * @type bool $echo Whether or not to echo the list of pages. Default true.
* @type string $exclude Comma-separated list of page IDs to exclude. Default empty. * @type string $exclude Comma-separated list of page IDs to exclude. Default empty.
* @type array $include Comma-separated list of page IDs to include. Default empty. * @type array $include Comma-separated list of page IDs to include. Default empty.
* @type string $link_after Text or HTML to follow the page link label. Default null. * @type string $link_after Text or HTML to follow the page link label. Default null.
* @type string $link_before Text or HTML to precede the page link label. Default null. * @type string $link_before Text or HTML to precede the page link label. Default null.
* @type string $post_type Post type to query for. Default 'page'. * @type string $post_type Post type to query for. Default 'page'.
* @type string $post_status Comma-separated list of post statuses to include. Default 'publish'. * @type string|array $post_status Comma-separated list or array of post statuses to include. Default 'publish'.
* @type string $show_date Whether to display the page publish or modified date for each page. Accepts * @type string $show_date Whether to display the page publish or modified date for each page. Accepts
* 'modified' or any other value. An empty value hides the date. Default empty. * 'modified' or any other value. An empty value hides the date. Default empty.
* @type string $sort_column Comma-separated list of column names to sort the pages by. Accepts 'post_author', * @type string $sort_column Comma-separated list of column names to sort the pages by. Accepts 'post_author',
* 'post_date', 'post_title', 'post_name', 'post_modified', 'post_modified_gmt', * 'post_date', 'post_title', 'post_name', 'post_modified', 'post_modified_gmt',
* 'menu_order', 'post_parent', 'ID', 'rand', or 'comment_count'. Default 'post_title'. * 'menu_order', 'post_parent', 'ID', 'rand', or 'comment_count'. Default 'post_title'.
* @type string $title_li List heading. Passing a null or empty value will result in no heading, and the list * @type string $title_li List heading. Passing a null or empty value will result in no heading, and the list
* will not be wrapped with unordered list `<ul>` tags. Default 'Pages'. * will not be wrapped with unordered list `<ul>` tags. Default 'Pages'.
* @type string $item_spacing Whether to preserve whitespace within the menu's HTML. Accepts 'preserve' or 'discard'. Default 'preserve'. * @type string $item_spacing Whether to preserve whitespace within the menu's HTML. Accepts 'preserve' or 'discard'.
* @type Walker $walker Walker instance to use for listing pages. Default empty (Walker_Page). * Default 'preserve'.
* @type Walker $walker Walker instance to use for listing pages. Default empty (Walker_Page).
* } * }
* @return string|void HTML list of pages. * @return string|void HTML list of pages.
*/ */
function wp_list_pages( $args = '' ) { function wp_list_pages( $args = '' ) {
$defaults = array( $defaults = array(
'depth' => 0, 'show_date' => '', 'depth' => 0,
'date_format' => get_option( 'date_format' ), 'show_date' => '',
'child_of' => 0, 'exclude' => '', 'date_format' => get_option( 'date_format' ),
'title_li' => __( 'Pages' ), 'echo' => 1, 'child_of' => 0,
'authors' => '', 'sort_column' => 'menu_order, post_title', 'exclude' => '',
'link_before' => '', 'link_after' => '', 'item_spacing' => 'preserve', 'walker' => '', 'title_li' => __( 'Pages' ),
'echo' => 1,
'authors' => '',
'sort_column' => 'menu_order, post_title',
'link_before' => '',
'link_after' => '',
'item_spacing' => 'preserve',
'walker' => '',
); );
$r = wp_parse_args( $args, $defaults ); $r = wp_parse_args( $args, $defaults );

24
wp-includes/post.php
View File

@ -4399,7 +4399,7 @@ function get_page_uri( $page = 0 ) {
* @type int $offset The number of pages to skip before returning. Requires `$number`. * @type int $offset The number of pages to skip before returning. Requires `$number`.
* Default 0. * Default 0.
* @type string $post_type The post type to query. Default 'page'. * @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. * @type string|array $post_status A comma-separated list or array of post statuses to include.
* Default 'publish'. * Default 'publish'.
* } * }
* @return array|false List of pages matching defaults or `$args`. * @return array|false List of pages matching defaults or `$args`.
@ -4408,13 +4408,21 @@ function get_pages( $args = array() ) {
global $wpdb; global $wpdb;
$defaults = array( $defaults = array(
'child_of' => 0, 'sort_order' => 'ASC', 'child_of' => 0,
'sort_column' => 'post_title', 'hierarchical' => 1, 'sort_order' => 'ASC',
'exclude' => array(), 'include' => array(), 'sort_column' => 'post_title',
'meta_key' => '', 'meta_value' => '', 'hierarchical' => 1,
'authors' => '', 'parent' => -1, 'exclude_tree' => array(), 'exclude' => array(),
'number' => '', 'offset' => 0, 'include' => array(),
'post_type' => 'page', 'post_status' => 'publish', 'meta_key' => '',
'meta_value' => '',
'authors' => '',
'parent' => -1,
'exclude_tree' => array(),
'number' => '',
'offset' => 0,
'post_type' => 'page',
'post_status' => 'publish',
); );
$r = wp_parse_args( $args, $defaults ); $r = wp_parse_args( $args, $defaults );

2
wp-includes/version.php
View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.7-alpha-38797'; $wp_version = '4.7-alpha-38798';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.