Inline doc fixes for get_next|previous|adjacent_post. props kawauso, fixes #15822.
git-svn-id: http://svn.automattic.com/wordpress/trunk@16951 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
parent
d8f0f1b4fb
commit
fe9e7af8a6
|
@ -1054,42 +1054,42 @@ function edit_bookmark_link( $link = '', $before = '', $after = '', $bookmark =
|
||||||
// Navigation links
|
// Navigation links
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Retrieve previous post link that is adjacent to current post.
|
* Retrieve previous post that is adjacent to current post.
|
||||||
*
|
*
|
||||||
* @since 1.5.0
|
* @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.
|
* @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 = '') {
|
function get_previous_post($in_same_cat = false, $excluded_categories = '') {
|
||||||
return get_adjacent_post($in_same_cat, $excluded_categories);
|
return get_adjacent_post($in_same_cat, $excluded_categories);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Retrieve next post link that is adjacent to current post.
|
* Retrieve next post that is adjacent to current post.
|
||||||
*
|
*
|
||||||
* @since 1.5.0
|
* @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.
|
* @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 = '') {
|
function get_next_post($in_same_cat = false, $excluded_categories = '') {
|
||||||
return get_adjacent_post($in_same_cat, $excluded_categories, false);
|
return get_adjacent_post($in_same_cat, $excluded_categories, false);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Retrieve adjacent post link.
|
* Retrieve adjacent post.
|
||||||
*
|
*
|
||||||
* Can either be next or previous post link.
|
* Can either be next or previous post.
|
||||||
*
|
*
|
||||||
* @since 2.5.0
|
* @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 string $excluded_categories Optional. Excluded categories IDs.
|
||||||
* @param bool $previous Optional. Whether to retrieve previous post.
|
* @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) {
|
function get_adjacent_post($in_same_cat = false, $excluded_categories = '', $previous = true) {
|
||||||
global $post, $wpdb;
|
global $post, $wpdb;
|
||||||
|
|
Loading…
Reference in New Issue