Changeset 54190

Timestamp:

09/16/2022 10:37:48 PM (2 years ago)

Author:

audrasjb

Message:

Docs: Update wp_rand docblock to clarify that it returns a non-negative number.

Props hakre, westi, jeremyfelt, neychok, sabernhardt, audrasjb.
Fixes #15089.

File:

• trunk/src/wp-includes/pluggable.php (modified) (2 diffs)

trunk/src/wp-includes/pluggable.php

@@ -2613 +2613 @@
 if ( ! function_exists( 'wp_rand' ) ) :
     /**
-     * Generates a random number.
+     * Generates a random non-negative number.
      *
      * @since 2.6.2
@@ -2625 +2625 @@
      * @param int $max Optional. Upper limit for the generated number.
      *                 Accepts positive integers. Defaults to 4294967295.
-     * @return int A random number between min and max.
+     * @return int A random non-negative number between min and max.
      */
     function wp_rand( $min = null, $max = null ) {