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

Timestamp:

01/03/2021 10:02:13 PM (4 years ago)

Author:

johnbillion

Message:

Docs: Promote many bool types to true or false where only that value is used.

See #51800

File:

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

trunk/src/wp-includes/functions.php

@@ -939 +939 @@
  * @param string $url        URL to retrieve HTTP headers from.
  * @param bool   $deprecated Not Used.
- * @return bool|string False on failure, headers on success.
+ * @return false|string False on failure, headers on success.
  */
 function wp_get_http_headers( $url, $deprecated = false ) {
@@ -3015 +3015 @@
      * @since 5.1.0 The $real_mime parameter was added.
      *
-     * @param array       $wp_check_filetype_and_ext {
+     * @param array        $wp_check_filetype_and_ext {
      *     Values for the extension, mime type, and corrected filename.
      *
@@ -3022 +3022 @@
      *     @type string|false $proper_filename File name with its correct extension, or false if it cannot be determined.
      * }
-     * @param string      $file                      Full path to the file.
-     * @param string      $filename                  The name of the file (may differ from $file due to
-     *                                               $file being in a tmp directory).
-     * @param string[]    $mimes                     Array of mime types keyed by their file extension regex.
-     * @param string|bool $real_mime                 The actual mime type or false if the type cannot be determined.
+     * @param string       $file                      Full path to the file.
+     * @param string       $filename                  The name of the file (may differ from $file due to
+     *                                                $file being in a tmp directory).
+     * @param string[]     $mimes                     Array of mime types keyed by their file extension regex.
+     * @param string|false $real_mime                 The actual mime type or false if the type cannot be determined.
      */
     return apply_filters( 'wp_check_filetype_and_ext', compact( 'ext', 'type', 'proper_filename' ), $file, $filename, $mimes, $real_mime );
@@ -6915 +6915 @@
  *                        the similarly arbitrary {@see '$context_memory_limit'} filter will be
  *                        invoked. Default 'admin'.
- * @return bool|int|string The limit that was set or false on failure.
+ * @return false|int|string The limit that was set or false on failure.
  */
 function wp_raise_memory_limit( $context = 'admin' ) {