Changeset 48068

Timestamp:

06/16/2020 09:22:09 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Docs: List the expected return type first for size_format() and wp_get_original_referer().

Follow-up to [46696], [47060].

See #49572.

File:

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

trunk/src/wp-includes/functions.php

@@ -447 +447 @@
  * @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 string|false False on failure. Number string on success.
+ * @return string|false Number string on success, false on failure.
  */
 function size_format( $bytes, $decimals = 0 ) {
@@ -1929 +1929 @@
  * @since 2.0.4
  *
- * @return string|false False if no original referer or original referer if set.
+ * @return string|false Original referer URL on success, false on failure.
  */
 function wp_get_original_referer() {
@@ -1935 +1935 @@
         return wp_validate_redirect( wp_unslash( $_REQUEST['_wp_original_http_referer'] ), false );
     }
+
     return false;
 }