<!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>[21598] trunk: Update phpdoc for functions that return WP_Post.</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, #logmsg > ol { margin-left: 0; 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/21598">21598</a></dd>
<dt>Author</dt> <dd>ryan</dd>
<dt>Date</dt> <dd>2012-08-23 20:34:41 +0000 (Thu, 23 Aug 2012)</dd>
</dl>
<h3>Log Message</h3>
<pre>Update phpdoc for functions that return WP_Post. Soft deprecate get_page(). see <a href="http://core.trac.wordpress.org/ticket/21309">#21309</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkwpadminincludespostphp">trunk/wp-admin/includes/post.php</a></li>
<li><a href="#trunkwpincludespostphp">trunk/wp-includes/post.php</a></li>
<li><a href="#trunkwpincludesqueryphp">trunk/wp-includes/query.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwpadminincludespostphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/includes/post.php (21597 => 21598)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/includes/post.php 2012-08-23 20:01:10 UTC (rev 21597)
+++ trunk/wp-admin/includes/post.php 2012-08-23 20:34:41 UTC (rev 21598)
</span><span class="lines">@@ -399,7 +399,7 @@
</span><span class="cx"> * @since 2.0.0
</span><span class="cx"> *
</span><span class="cx"> * @param string $post_type A post type string, defaults to 'post'.
</span><del>- * @return object stdClass object containing all the default post data as attributes
</del><ins>+ * @return WP_Post Post object containing all the default post data as attributes
</ins><span class="cx"> */
</span><span class="cx"> function get_default_post_to_edit( $post_type = 'post', $create_in_db = false ) {
</span><span class="cx"> global $wpdb;
</span><span class="lines">@@ -455,7 +455,7 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 2.5.0
</span><span class="cx"> *
</span><del>- * @return object stdClass object containing all the default post data as attributes
</del><ins>+ * @return WP_Post Post object containing all the default post data as attributes
</ins><span class="cx"> */
</span><span class="cx"> function get_default_page_to_edit() {
</span><span class="cx"> $page = get_default_post_to_edit();
</span><span class="lines">@@ -468,8 +468,8 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 2.0.0
</span><span class="cx"> *
</span><del>- * @param unknown_type $id
- * @return unknown
</del><ins>+ * @param int $id
+ * @return WP_Post
</ins><span class="cx"> */
</span><span class="cx"> function get_post_to_edit( $id ) {
</span><span class="cx">
</span></span></pre></div>
<a id="trunkwpincludespostphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/post.php (21597 => 21598)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/post.php 2012-08-23 20:01:10 UTC (rev 21597)
+++ trunk/wp-includes/post.php 2012-08-23 20:34:41 UTC (rev 21598)
</span><span class="lines">@@ -375,7 +375,7 @@
</span><span class="cx"> * @param int|object $post Post ID or post object.
</span><span class="cx"> * @param string $output Optional, default is Object. Either OBJECT, ARRAY_A, or ARRAY_N.
</span><span class="cx"> * @param string $filter Optional, default is raw.
</span><del>- * @return mixed Post data or null on failure
</del><ins>+ * @return WP_Post|null WP_Post on success or null on failure
</ins><span class="cx"> */
</span><span class="cx"> function get_post( $post, $output = OBJECT, $filter = 'raw' ) {
</span><span class="cx"> if ( empty( $post ) && isset( $GLOBALS['post'] ) )
</span><span class="lines">@@ -1779,9 +1779,9 @@
</span><span class="cx"> * @since 2.3.0
</span><span class="cx"> * @uses sanitize_post_field() Used to sanitize the fields.
</span><span class="cx"> *
</span><del>- * @param object|array $post The Post Object or Array
</del><ins>+ * @param object|WP_Post|array $post The Post Object or Array
</ins><span class="cx"> * @param string $context Optional, default is 'display'. How to sanitize post fields.
</span><del>- * @return object|array The now sanitized Post Object or Array (will be the same type as $post)
</del><ins>+ * @return object|WP_Post|array The now sanitized Post Object or Array (will be the same type as $post)
</ins><span class="cx"> */
</span><span class="cx"> function sanitize_post($post, $context = 'display') {
</span><span class="cx"> if ( is_object($post) ) {
</span><span class="lines">@@ -2498,7 +2498,7 @@
</span><span class="cx"> *
</span><span class="cx"> * @param int $postid Post ID.
</span><span class="cx"> * @param string $mode How to return result, either OBJECT, ARRAY_N, or ARRAY_A.
</span><del>- * @return object|array Post object or array holding post contents and information
</del><ins>+ * @return WP_Post|array WP_Post object or array holding post contents and information
</ins><span class="cx"> */
</span><span class="cx"> function wp_get_single_post($postid = 0, $mode = OBJECT) {
</span><span class="cx"> $postid = (int) $postid;
</span><span class="lines">@@ -3288,12 +3288,15 @@
</span><span class="cx"> /**
</span><span class="cx"> * Retrieves page data given a page ID or page object.
</span><span class="cx"> *
</span><ins>+ * Use get_post() instead instead of get_page().
+ *
</ins><span class="cx"> * @since 1.5.1
</span><ins>+ * @deprecated 3.5.0
</ins><span class="cx"> *
</span><span class="cx"> * @param mixed $page Page object or page ID. Passed by reference.
</span><span class="cx"> * @param string $output What to output. OBJECT, ARRAY_A, or ARRAY_N.
</span><span class="cx"> * @param string $filter How the return value should be filtered.
</span><del>- * @return mixed Page data.
</del><ins>+ * @return WP_Post|null WP_Post on success or null on failure
</ins><span class="cx"> */
</span><span class="cx"> function get_page( $page, $output = OBJECT, $filter = 'raw') {
</span><span class="cx"> return get_post( $page, $output, $filter );
</span><span class="lines">@@ -3308,7 +3311,7 @@
</span><span class="cx"> * @param string $page_path Page path
</span><span class="cx"> * @param string $output Optional. Output type. OBJECT, ARRAY_N, or ARRAY_A. Default OBJECT.
</span><span class="cx"> * @param string $post_type Optional. Post type. Default page.
</span><del>- * @return mixed Null when complete.
</del><ins>+ * @return WP_Post|null WP_Post on success or null on failure
</ins><span class="cx"> */
</span><span class="cx"> function get_page_by_path($page_path, $output = OBJECT, $post_type = 'page') {
</span><span class="cx"> global $wpdb;
</span><span class="lines">@@ -3362,7 +3365,7 @@
</span><span class="cx"> * @param string $page_title Page title
</span><span class="cx"> * @param string $output Optional. Output type. OBJECT, ARRAY_N, or ARRAY_A. Default OBJECT.
</span><span class="cx"> * @param string $post_type Optional. Post type. Default page.
</span><del>- * @return mixed
</del><ins>+ * @return WP_Post|null WP_Post on success or null on failure
</ins><span class="cx"> */
</span><span class="cx"> function get_page_by_title($page_title, $output = OBJECT, $post_type = 'page' ) {
</span><span class="cx"> global $wpdb;
</span></span></pre></div>
<a id="trunkwpincludesqueryphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/query.php (21597 => 21598)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/query.php 2012-08-23 20:01:10 UTC (rev 21597)
+++ trunk/wp-includes/query.php 2012-08-23 20:34:41 UTC (rev 21598)
</span><span class="lines">@@ -2785,7 +2785,7 @@
</span><span class="cx"> * @since 1.5.0
</span><span class="cx"> * @access public
</span><span class="cx"> *
</span><del>- * @return object Next post.
</del><ins>+ * @return WP_Post Next post.
</ins><span class="cx"> */
</span><span class="cx"> function next_post() {
</span><span class="cx">
</span></span></pre>
</div>
</div>
</body>
</html>