WordPress.org

Make WordPress Core

Changeset 16951


Ignore:
Timestamp:
12/15/10 16:45:14 (3 years ago)
Author:
nacin
Message:

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

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/wp-includes/link-template.php

    r16938 r16951  
    10551055 
    10561056/** 
    1057  * Retrieve previous post link that is adjacent to current post. 
     1057 * Retrieve previous post that is adjacent to current post. 
    10581058 * 
    10591059 * @since 1.5.0 
    10601060 * 
    1061  * @param bool $in_same_cat Optional. Whether link should be in same category. 
     1061 * @param bool $in_same_cat Optional. Whether post should be in same category. 
    10621062 * @param string $excluded_categories Optional. Excluded categories IDs. 
    1063  * @return string 
     1063 * @return mixed Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists. 
    10641064 */ 
    10651065function get_previous_post($in_same_cat = false, $excluded_categories = '') { 
     
    10681068 
    10691069/** 
    1070  * Retrieve next post link that is adjacent to current post. 
     1070 * Retrieve next post that is adjacent to current post. 
    10711071 * 
    10721072 * @since 1.5.0 
    10731073 * 
    1074  * @param bool $in_same_cat Optional. Whether link should be in same category. 
     1074 * @param bool $in_same_cat Optional. Whether post should be in same category. 
    10751075 * @param string $excluded_categories Optional. Excluded categories IDs. 
    1076  * @return string 
     1076 * @return mixed Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists. 
    10771077 */ 
    10781078function get_next_post($in_same_cat = false, $excluded_categories = '') { 
     
    10811081 
    10821082/** 
    1083  * Retrieve adjacent post link. 
    1084  * 
    1085  * Can either be next or previous post link. 
     1083 * Retrieve adjacent post. 
     1084 * 
     1085 * Can either be next or previous post. 
    10861086 * 
    10871087 * @since 2.5.0 
    10881088 * 
    1089  * @param bool $in_same_cat Optional. Whether link should be in same category. 
     1089 * @param bool $in_same_cat Optional. Whether post should be in same category. 
    10901090 * @param string $excluded_categories Optional. Excluded categories IDs. 
    10911091 * @param bool $previous Optional. Whether to retrieve previous post. 
    1092  * @return string 
     1092 * @return mixed Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists. 
    10931093 */ 
    10941094function get_adjacent_post($in_same_cat = false, $excluded_categories = '', $previous = true) { 
Note: See TracChangeset for help on using the changeset viewer.