Changeset 16951 for trunk/wp-includes/link-template.php

Timestamp:

12/15/2010 04:45:14 PM (14 years ago)

Author:

nacin

Message:

Inline doc fixes for get_next|previous|adjacent_post. props kawauso, fixes #15822.

File:

• trunk/wp-includes/link-template.php (modified) (3 diffs)

trunk/wp-includes/link-template.php

@@ -1055 +1055 @@
 
 /**
- * Retrieve previous post link that is adjacent to current post.
+ * Retrieve previous post that is adjacent to current post.
  *
  * @since 1.5.0
  *
- * @param bool $in_same_cat Optional. Whether link should be in same category.
+ * @param bool $in_same_cat Optional. Whether post should be in same category.
  * @param string $excluded_categories Optional. Excluded categories IDs.
- * @return string
+ * @return mixed Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.
  */
 function get_previous_post($in_same_cat = false, $excluded_categories = '') {
@@ -1068 +1068 @@
 
 /**
- * Retrieve next post link that is adjacent to current post.
+ * Retrieve next post that is adjacent to current post.
  *
  * @since 1.5.0
  *
- * @param bool $in_same_cat Optional. Whether link should be in same category.
+ * @param bool $in_same_cat Optional. Whether post should be in same category.
  * @param string $excluded_categories Optional. Excluded categories IDs.
- * @return string
+ * @return mixed Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.
  */
 function get_next_post($in_same_cat = false, $excluded_categories = '') {
@@ -1081 +1081 @@
 
 /**
- * Retrieve adjacent post link.
- *
- * Can either be next or previous post link.
+ * Retrieve adjacent post.
+ *
+ * Can either be next or previous post.
  *
  * @since 2.5.0
  *
- * @param bool $in_same_cat Optional. Whether link should be in same category.
+ * @param bool $in_same_cat Optional. Whether post should be in same category.
  * @param string $excluded_categories Optional. Excluded categories IDs.
  * @param bool $previous Optional. Whether to retrieve previous post.
- * @return string
+ * @return mixed Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.
  */
 function get_adjacent_post($in_same_cat = false, $excluded_categories = '', $previous = true) {