Changeset 46599

Timestamp:

10/26/2019 11:47:04 PM (5 years ago)

Author:

johnbillion

Message:

Docs: Correct and improve inline docs for the file type functions.

See #48303

File:

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

trunk/src/wp-includes/functions.php

@@ -2617 +2617 @@
  * @param string[] $mimes    Optional. Array of mime types keyed by their file extension regex.
  * @return array {
- *     Values with extension first and mime type.
- *
- *     @type string $0 File extension.
- *     @type string $1 File mime type.
+ *     Values for the extension and mime type.
+ *
+ *     @type string|false $0 File extension, or false if the file doesn't match a mime type.
+ *     @type string|false $1 File mime type, or false if the file doesn't match a mime type.
  * }
  */
@@ -2658 +2658 @@
  *                           in a tmp directory).
  * @param string[] $mimes    Optional. Array of mime types keyed by their file extension regex.
- * @return array Values for the extension, MIME, and either a corrected filename or false
- *               if original $filename is valid.
+ * @return array {
+ *     Values for the extension, mime type, and corrected filename.
+ *
+ *     @type string|false $0 File extension, or false if the file doesn't match a mime type.
+ *     @type string|false $1 File mime type, or false if the file doesn't match a mime type.
+ *     @type string|false $2 File name with its correct extension, or false if it cannot be determined.
+ * }
  */
 function wp_check_filetype_and_ext( $file, $filename, $mimes = null ) {
@@ -2815 +2820 @@
      * @since 5.1.0 The $real_mime parameter was added.
      *
-     * @param array       $wp_check_filetype_and_ext File data array containing 'ext', 'type', and
-     *                                               'proper_filename' keys.
+     * @param array       $wp_check_filetype_and_ext {
+     *     Values for the extension, mime type, and corrected filename.
+     *
+     *     @type string|false $0 File extension, or false if the file doesn't match a mime type.
+     *     @type string|false $1 File mime type, or false if the file doesn't match a mime type.
+     *     @type string|false $2 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