WordPress.org

Make WordPress Core

Changeset 36763


Ignore:
Timestamp:
02/28/2016 07:31:31 PM (4 years ago)
Author:
DrewAPicture
Message:

Docs: Improve a variety of DocBlocks in wp-includes/deprecated.php.

See #32246.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/deprecated.php

    r36760 r36763  
    1414
    1515/**
    16  * Entire Post data.
     16 * Retrieves all post data for a given post.
    1717 *
    1818 * @since 0.71
     
    2020 * @see get_post()
    2121 *
    22  * @param int $postid
    23  * @return array
     22 * @param int $postid Post ID.
     23 * @return array Post data.
    2424 */
    2525function get_postdata($postid) {
     
    7171
    7272/**
    73  * Return or Print Category ID.
     73 * Returns or prints a category ID.
    7474 *
    7575 * @since 0.71
     
    7777 * @see get_the_category()
    7878 *
    79  * @param bool $echo
    80  * @return null|int
     79 * @param bool $echo Optional. Whether to echo the output. Default true.
     80 * @return int Category ID.
    8181 */
    8282function the_category_ID($echo = true) {
     
    9494
    9595/**
    96  * Print category with optional text before and after.
     96 * Prints a category with optional text before and after.
    9797 *
    9898 * @since 0.71
     
    100100 * @see get_the_category_by_ID()
    101101 *
    102  * @param string $before
    103  * @param string $after
    104  */
    105 function the_category_head($before='', $after='') {
     102 * @param string $before Optional. Text to display before the category. Default empty.
     103 * @param string $after  Optional. Text to display after the category. Default empty.
     104 */
     105function the_category_head( $before = '', $after = '' ) {
    106106    global $currentcat, $previouscat;
    107107
     
    120120
    121121/**
    122  * Prints link to the previous post.
     122 * Prints a link to the previous post.
    123123 *
    124124 * @since 1.5.0
     
    130130 * @param string $title
    131131 * @param string $in_same_cat
    132  * @param int $limitprev
     132 * @param int    $limitprev
    133133 * @param string $excluded_categories
    134134 */
Note: See TracChangeset for help on using the changeset viewer.