Changeset 21598

Timestamp:

08/23/2012 08:34:41 PM (12 years ago)

Author:

ryan

Message:

Update phpdoc for functions that return WP_Post. Soft deprecate get_page(). see #21309

Location:

trunk

Files:

• wp-admin/includes/post.php (modified) (3 diffs)
• wp-includes/post.php (modified) (6 diffs)
• wp-includes/query.php (modified) (1 diff)

trunk/wp-admin/includes/post.php

@@ -400 +400 @@
  *
  * @param string $post_type A post type string, defaults to 'post'.
- * @return object stdClass object containing all the default post data as attributes
+ * @return WP_Post Post object containing all the default post data as attributes
  */
 function get_default_post_to_edit( $post_type = 'post', $create_in_db = false ) {
@@ -456 +456 @@
  * @since 2.5.0
  *
- * @return object stdClass object containing all the default post data as attributes
+ * @return WP_Post Post object containing all the default post data as attributes
  */
 function get_default_page_to_edit() {
@@ -469 +469 @@
  * @since 2.0.0
  *
- * @param unknown_type $id
- * @return unknown
+ * @param int $id
+ * @return WP_Post
  */
 function get_post_to_edit( $id ) {

trunk/wp-includes/post.php

@@ -376 +376 @@
  * @param string $output Optional, default is Object. Either OBJECT, ARRAY_A, or ARRAY_N.
  * @param string $filter Optional, default is raw.
- * @return mixed Post data or null on failure
+ * @return WP_Post|null WP_Post on success or null on failure
  */
 function get_post( $post, $output = OBJECT, $filter = 'raw' ) {
@@ -1780 +1780 @@
  * @uses sanitize_post_field() Used to sanitize the fields.
  *
- * @param object|array $post The Post Object or Array
+ * @param object|WP_Post|array $post The Post Object or Array
  * @param string $context Optional, default is 'display'. How to sanitize post fields.
- * @return object|array The now sanitized Post Object or Array (will be the same type as $post)
+ * @return object|WP_Post|array The now sanitized Post Object or Array (will be the same type as $post)
  */
 function sanitize_post($post, $context = 'display') {
@@ -2499 +2499 @@
  * @param int $postid Post ID.
  * @param string $mode How to return result, either OBJECT, ARRAY_N, or ARRAY_A.
- * @return object|array Post object or array holding post contents and information
+ * @return WP_Post|array WP_Post object or array holding post contents and information
  */
 function wp_get_single_post($postid = 0, $mode = OBJECT) {
@@ -3289 +3289 @@
  * Retrieves page data given a page ID or page object.
  *
+ * Use get_post() instead instead of get_page().
+ *
  * @since 1.5.1
+ * @deprecated 3.5.0
  *
  * @param mixed $page Page object or page ID. Passed by reference.
  * @param string $output What to output. OBJECT, ARRAY_A, or ARRAY_N.
  * @param string $filter How the return value should be filtered.
- * @return mixed Page data.
+ * @return WP_Post|null WP_Post on success or null on failure
  */
 function get_page( $page, $output = OBJECT, $filter = 'raw') {
@@ -3309 +3312 @@
  * @param string $output Optional. Output type. OBJECT, ARRAY_N, or ARRAY_A. Default OBJECT.
  * @param string $post_type Optional. Post type. Default page.
- * @return mixed Null when complete.
+ * @return WP_Post|null WP_Post on success or null on failure
  */
 function get_page_by_path($page_path, $output = OBJECT, $post_type = 'page') {
@@ -3363 +3366 @@
  * @param string $output Optional. Output type. OBJECT, ARRAY_N, or ARRAY_A. Default OBJECT.
  * @param string $post_type Optional. Post type. Default page.
- * @return mixed
+ * @return WP_Post|null WP_Post on success or null on failure
  */
 function get_page_by_title($page_title, $output = OBJECT, $post_type = 'page' ) {

trunk/wp-includes/query.php

@@ -2786 +2786 @@
      * @access public
      *
-     * @return object Next post.
+     * @return WP_Post Next post.
      */
     function next_post() {