Make WordPress Core

Changeset 30983


Ignore:
Timestamp:
12/20/2014 11:03:21 PM (9 years ago)
Author:
wonderboymusic
Message:

Correct the @param docs for arguments that are truthy/falsey.

See #30799.

Location:
trunk/src
Files:
5 edited

Legend:

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

    r30982 r30983  
    711711 * @since 0.71
    712712 *
    713  * @param int $edit      Accepts 1|true for editing the date, 0|false for adding the date.
    714  * @param int $for_post  Accepts 1|true for applying the date to a post, 0|false for a comment.
    715  * @param int $tab_index The tabindex attribute to add. Default 0.
    716  * @param int $multi     Optional. Whether the additional fields and buttons should be added.
     713 * @param int|bool $edit      Accepts 1|true for editing the date, 0|false for adding the date.
     714 * @param int|bool $for_post  Accepts 1|true for applying the date to a post, 0|false for a comment.
     715 * @param int      $tab_index The tabindex attribute to add. Default 0.
     716 * @param int|bool $multi     Optional. Whether the additional fields and buttons should be added.
    717717 *                            Default 0|false.
    718718 */
  • trunk/src/wp-includes/general-template.php

    r30982 r30983  
    13131313 *     @type string     $after           Markup to append to the end of each link. Default empty.
    13141314 *     @type bool       $show_post_count Whether to display the post count alongside the link. Default false.
    1315  *     @type bool       $echo            Whether to echo or return the links list. Default 1|true to echo.
     1315 *     @type bool|int   $echo            Whether to echo or return the links list. Default 1|true to echo.
    13161316 *     @type string     $order           Whether to use ascending or descending order. Accepts 'ASC', or 'DESC'.
    13171317 *                                       Default 'DESC'.
  • trunk/src/wp-includes/load.php

    r30581 r30983  
    218218 * @since 0.71
    219219 *
    220  * @global float $timestart Seconds from when timer_start() is called.
    221  * @global float $timeend   Seconds from when function is called.
    222  *
    223  * @param int $display   Whether to echo or return the results. Accepts 0|false for return,
    224  *                       1|true for echo. Default 0|false.
    225  * @param int $precision The number of digits from the right of the decimal to display.
    226  *                       Default 3.
     220 * @global float   $timestart Seconds from when timer_start() is called.
     221 * @global float   $timeend   Seconds from when function is called.
     222 *
     223 * @param int|bool $display   Whether to echo or return the results. Accepts 0|false for return,
     224 *                            1|true for echo. Default 0|false.
     225 * @param int      $precision The number of digits from the right of the decimal to display.
     226 *                            Default 3.
    227227 * @return string The "second.microsecond" finished time calculation. The number is formatted
    228228 *                for human consumption, both localized and rounded.
  • trunk/src/wp-includes/post-template.php

    r30912 r30983  
    11121112 *     for additional arguments.
    11131113 *
    1114  * @type string     $sort_column How to short the list of pages. Accepts post column names.
    1115  *                               Default 'menu_order, post_title'.
    1116  * @type string     $menu_class  Class to use for the div ID containing the page list. Default 'menu'.
    1117  * @type bool       $echo        Whether to echo the list or return it. Accepts true (echo) or false (return).
    1118  *                               Default true.
    1119  * @type string     $link_before The HTML or text to prepend to $show_home text. Default empty.
    1120  * @type string     $link_after  The HTML or text to append to $show_home text. Default empty.
    1121  * @type int|string $show_home   Whether to display the link to the home page. Can just enter the text
    1122  *                               you'd like shown for the home link. 1|true defaults to 'Home'.
     1114 * @type string          $sort_column How to short the list of pages. Accepts post column names.
     1115 *                                    Default 'menu_order, post_title'.
     1116 * @type string          $menu_class  Class to use for the div ID containing the page list. Default 'menu'.
     1117 * @type bool            $echo        Whether to echo the list or return it. Accepts true (echo) or false (return).
     1118 *                                    Default true.
     1119 * @type string          $link_before The HTML or text to prepend to $show_home text. Default empty.
     1120 * @type string          $link_after  The HTML or text to append to $show_home text. Default empty.
     1121 * @type int|bool|string $show_home   Whether to display the link to the home page. Can just enter the text
     1122 *                                    you'd like shown for the home link. 1|true defaults to 'Home'.
    11231123 * }
    11241124 * @return string html menu
  • trunk/src/wp-includes/query.php

    r30771 r30983  
    14731473     *                                                 Default all fields. Accepts 'ids', 'id=>parent'.
    14741474     *     @type int          $hour                    Hour of the day. Default empty. Accepts numbers 0-23.
    1475      *     @type bool         $ignore_sticky_posts     Whether to ignore sticky posts or not. Setting this to false
     1475     *     @type int|bool     $ignore_sticky_posts     Whether to ignore sticky posts or not. Setting this to false
    14761476     *                                                 excludes stickies from 'post__in'. Accepts 1|true, 0|false.
    14771477     *                                                 Default 0|false.
Note: See TracChangeset for help on using the changeset viewer.