<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[25271] trunk/src/wp-includes/post.php: More adjustments and improvements for inline documentation for get_pages().</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/25271">25271</a></dd>
<dt>Author</dt> <dd>nacin</dd>
<dt>Date</dt> <dd>2013-09-06 01:20:17 +0000 (Fri, 06 Sep 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>More adjustments and improvements for inline documentation for get_pages(). see <a href="http://core.trac.wordpress.org/ticket/25186">#25186</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludespostphp">trunk/src/wp-includes/post.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludespostphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/post.php (25270 => 25271)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/post.php 2013-09-05 23:35:30 UTC (rev 25270)
+++ trunk/src/wp-includes/post.php 2013-09-06 01:20:17 UTC (rev 25271)
</span><span class="lines">@@ -3615,32 +3615,43 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Retrieve a list of pages
</del><ins>+ * Retrieve a list of pages.
</ins><span class="cx"> *
</span><span class="cx"> * @global wpdb $wpdb WordPress database abstraction object
</span><span class="cx"> *
</span><span class="cx"> * @since 1.5.0
</span><span class="cx"> *
</span><del>- * @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').
</del><ins>+ * @param mixed $args {
+ * Array or string of arguments. Optional.
+ *
+ * @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'.
</ins><span class="cx"> * }
</span><span class="cx"> * @return array List of pages matching defaults or $args.
</span><span class="cx"> */
</span><del>-function get_pages( $args = '' ) {
</del><ins>+function get_pages( $args = array() ) {
</ins><span class="cx"> global $wpdb;
</span><span class="cx">
</span><span class="cx"> $pages = false;
</span></span></pre>
</div>
</div>
</body>
</html>