WordPress.org

Make WordPress Core


Ignore:
Timestamp:
11/30/2014 11:23:37 PM (5 years ago)
Author:
wonderboymusic
Message:

Improve various @param docs.

See #30224.

File:
1 edited

Legend:

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

    r30656 r30674  
    198198 * @param int|string $bytes    Number of bytes. Note max integer size for integers.
    199199 * @param int        $decimals Optional. Precision of number of decimal places. Default 0.
    200  * @return bool|string False on failure. Number string on success.
     200 * @return string|false False on failure. Number string on success.
    201201 */
    202202function size_format( $bytes, $decimals = 0 ) {
     
    642642 * @global string $previousday The day of the previous post in the loop.
    643643 *
    644  * @return int|bool 1|true when new day, 0|false if not a new day.
     644 * @return int 1 when new day, 0 if not a new day.
    645645 */
    646646function is_new_day() {
     
    843843 *
    844844 * @param string $uri URI/URL of web page to retrieve.
    845  * @return bool|string HTTP content. False on failure.
     845 * @return false|string HTTP content. False on failure.
    846846 */
    847847function wp_remote_fopen( $uri ) {
     
    13281328 * @since 2.0.4
    13291329 *
    1330  * @param string $actionurl URL to add nonce action.
    1331  * @param string $action    Optional. Nonce action name. Default -1.
    1332  * @param string $name      Optional. Nonce name. Default '_wpnonce'.
     1330 * @param string     $actionurl URL to add nonce action.
     1331 * @param int|string $action    Optional. Nonce action name. Default -1.
     1332 * @param string     $name      Optional. Nonce name. Default '_wpnonce'.
    13331333 * @return string Escaped URL with nonce action added.
    13341334 */
     
    13581358 * @since 2.0.4
    13591359 *
    1360  * @param string $action  Optional. Action name. Default -1.
    1361  * @param string $name    Optional. Nonce name. Default '_wpnonce'.
    1362  * @param bool   $referer Optional. Whether to set the referer field for validation. Default true.
    1363  * @param bool   $echo    Optional. Whether to display or return hidden form field. Default true.
     1360 * @param int|string $action  Optional. Action name. Default -1.
     1361 * @param string     $name    Optional. Nonce name. Default '_wpnonce'.
     1362 * @param bool       $referer Optional. Whether to set the referer field for validation. Default true.
     1363 * @param bool       $echo    Optional. Whether to display or return hidden form field. Default true.
    13641364 * @return string Nonce field HTML markup.
    13651365 */
     
    14271427 * @since 2.0.4
    14281428 *
    1429  * @return string|bool False on failure. Referer URL on success.
     1429 * @return false|string False on failure. Referer URL on success.
    14301430 */
    14311431function wp_get_referer() {
     
    14481448 * @since 2.0.4
    14491449 *
    1450  * @return string|bool False if no original referer or original referer if set.
     1450 * @return string|false False if no original referer or original referer if set.
    14511451 */
    14521452function wp_get_original_referer() {
     
    19191919 * @since 2.0.0
    19201920 *
    1921  * @param string $name       Filename.
    1922  * @param null   $deprecated Never used. Set to null.
    1923  * @param mixed  $bits       File content
    1924  * @param string $time       Optional. Time formatted in 'yyyy/mm'. Default null.
     1921 * @param string       $name       Filename.
     1922 * @param null|string  $deprecated Never used. Set to null.
     1923 * @param mixed        $bits       File content
     1924 * @param string       $time       Optional. Time formatted in 'yyyy/mm'. Default null.
    19251925 * @return array
    19261926 */
Note: See TracChangeset for help on using the changeset viewer.