Changeset 30674 for trunk/src/wp-includes/functions.php

Timestamp:

11/30/2014 11:23:37 PM (11 years ago)

Author:

wonderboymusic

Message:

Improve various @param docs.

See #30224.

File:

• trunk/src/wp-includes/functions.php (modified) (8 diffs)

trunk/src/wp-includes/functions.php

@@ -198 +198 @@
  * @param int|string $bytes    Number of bytes. Note max integer size for integers.
  * @param int        $decimals Optional. Precision of number of decimal places. Default 0.
- * @return bool|string False on failure. Number string on success.
+ * @return string|false False on failure. Number string on success.
  */
 function size_format( $bytes, $decimals = 0 ) {
@@ -642 +642 @@
  * @global string $previousday The day of the previous post in the loop.
  *
- * @return int|bool 1|true when new day, 0|false if not a new day.
+ * @return int 1 when new day, 0 if not a new day.
  */
 function is_new_day() {
@@ -843 +843 @@
  *
  * @param string $uri URI/URL of web page to retrieve.
- * @return bool|string HTTP content. False on failure.
+ * @return false|string HTTP content. False on failure.
  */
 function wp_remote_fopen( $uri ) {
@@ -1328 +1328 @@
  * @since 2.0.4
  *
- * @param string $actionurl URL to add nonce action.
- * @param string $action    Optional. Nonce action name. Default -1.
- * @param string $name      Optional. Nonce name. Default '_wpnonce'.
+ * @param string     $actionurl URL to add nonce action.
+ * @param int|string $action    Optional. Nonce action name. Default -1.
+ * @param string     $name      Optional. Nonce name. Default '_wpnonce'.
  * @return string Escaped URL with nonce action added.
  */
@@ -1358 +1358 @@
  * @since 2.0.4
  *
- * @param string $action  Optional. Action name. Default -1.
- * @param string $name    Optional. Nonce name. Default '_wpnonce'.
- * @param bool   $referer Optional. Whether to set the referer field for validation. Default true.
- * @param bool   $echo    Optional. Whether to display or return hidden form field. Default true.
+ * @param int|string $action  Optional. Action name. Default -1.
+ * @param string     $name    Optional. Nonce name. Default '_wpnonce'.
+ * @param bool       $referer Optional. Whether to set the referer field for validation. Default true.
+ * @param bool       $echo    Optional. Whether to display or return hidden form field. Default true.
  * @return string Nonce field HTML markup.
  */
@@ -1427 +1427 @@
  * @since 2.0.4
  *
- * @return string|bool False on failure. Referer URL on success.
+ * @return false|string False on failure. Referer URL on success.
  */
 function wp_get_referer() {
@@ -1448 +1448 @@
  * @since 2.0.4
  *
- * @return string|bool False if no original referer or original referer if set.
+ * @return string|false False if no original referer or original referer if set.
  */
 function wp_get_original_referer() {
@@ -1919 +1919 @@
  * @since 2.0.0
  *
- * @param string $name       Filename.
- * @param null   $deprecated Never used. Set to null.
- * @param mixed  $bits       File content
- * @param string $time       Optional. Time formatted in 'yyyy/mm'. Default null.
+ * @param string       $name       Filename.
+ * @param null|string  $deprecated Never used. Set to null.
+ * @param mixed        $bits       File content
+ * @param string       $time       Optional. Time formatted in 'yyyy/mm'. Default null.
  * @return array
  */