<!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>[29113] trunk/src/wp-includes/post.php: Convert default arguments documentation for `get_posts()` into a hash notation.</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/29113">29113</a></dd>
<dt>Author</dt> <dd>DrewAPicture</dd>
<dt>Date</dt> <dd>2014-07-11 23:33:33 +0000 (Fri, 11 Jul 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Convert default arguments documentation for `get_posts()` into a hash notation.
Props coffee2code for the initial patch.
See <a href="http://core.trac.wordpress.org/ticket/28841">#28841</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 (29112 => 29113)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/post.php 2014-07-11 23:12:42 UTC (rev 29112)
+++ trunk/src/wp-includes/post.php 2014-07-11 23:33:33 UTC (rev 29113)
</span><span class="lines">@@ -1588,6 +1588,7 @@
</span><span class="cx"> * Build an object with all post type labels out of a post type object
</span><span class="cx"> *
</span><span class="cx"> * Accepted keys of the label array in the post type object:
</span><ins>+ *
</ins><span class="cx"> * - name - general name for the post type, usually plural. The same and overridden
</span><span class="cx"> * by $post_type_object->label. Default is Posts/Pages
</span><span class="cx"> * - singular_name - name for one object of this post type. Default is Post/Page
</span><span class="lines">@@ -1810,26 +1811,29 @@
</span><span class="cx"> * Retrieve list of latest posts or posts matching criteria.
</span><span class="cx"> *
</span><span class="cx"> * The defaults are as follows:
</span><del>- * 'numberposts' - Default is 5. Total number of posts to retrieve.
- * 'offset' - Default is 0. See {@link WP_Query::query()} for more.
- * 'category' - What category to pull the posts from.
- * 'orderby' - Default is 'date', which orders based on post_date. How to order the posts.
- * 'order' - Default is 'DESC'. The order to retrieve the posts.
- * 'include' - See {@link WP_Query::query()} for more.
- * 'exclude' - See {@link WP_Query::query()} for more.
- * 'meta_key' - See {@link WP_Query::query()} for more.
- * 'meta_value' - See {@link WP_Query::query()} for more.
- * 'post_type' - Default is 'post'. Can be 'page', or 'attachment' to name a few.
- * 'post_parent' - The parent of the post or post type.
- * 'post_status' - Default is 'publish'. Post status to retrieve.
</del><span class="cx"> *
</span><span class="cx"> * @since 1.2.0
</span><span class="cx"> *
</span><del>- * @todo Tie to WP_Query default args hash notation.
</del><ins>+ * @see WP_Query::parse_query()
</ins><span class="cx"> *
</span><del>- * @see WP_Query::query()
</del><ins>+ * @param array $args {
+ * Optional. Arguments to retrieve posts. {@see WP_Query::parse_query()} for more
+ * available arguments.
</ins><span class="cx"> *
</span><del>- * @param array $args Optional. Overrides defaults.
</del><ins>+ * @type int $numberposts Total number of posts to retrieve. Is an alias of $posts_per_page
+ * in WP_Query. Accepts 1+ and -1 for all. Default 5.
+ * @type int $offset The number of posts to offset before retrieval. Default 0.
+ * @type int|string $category Category ID or comma-separated list of IDs (this or any children).
+ * Is an alias of $cat in WP_Query. Default 0.
+ * @type string $orderby Which field to order posts by. Accepts post fields. Default 'date'.
+ * @type array $include An array of post IDs to retrieve, sticky posts will be included.
+ * Is an alias of $post__in in WP_Query. Default empty array.
+ * @type array $exclude An array of post IDs not to retrieve. Default empty array.
+ * @type string $meta_key Custom field key. Default empty.
+ * @type mixed $meta_value Custom field value. Default empty string.
+ * @type string $post_type Post type. Default 'post'.
+ * @type bool $suppress_filters Whether to suppress filters. Default true.
+ * }
</ins><span class="cx"> * @return array List of posts.
</span><span class="cx"> */
</span><span class="cx"> function get_posts( $args = null ) {
</span></span></pre>
</div>
</div>
</body>
</html>