Changeset 57687

Timestamp:

02/21/2024 07:25:18 PM (10 months ago)

Author:

joedolson

Message:

Media: Ensure wp_mine_type_icon() returns expected file type.

Add an argument to wp_mime_type_icon() to control the file type returned. Following [57638], there are two file formats in the media icons directory. Different systems would pull up different files by default dependent on the order loaded into the cached array, causing intermittent test failures and unpredictable behavior.

Function update allows core usages to always return the .svg while maintaining backwards compatibility for any extended usage that expects a .png. Follow up to [57638].

Also handles a missed case in media list view.

Props SergeyBiryukov, sabernhardt, joedolson, antpb.
Fixes #31352.

Location:

trunk

Files:

• src/wp-includes/customize/class-wp-customize-media-control.php (modified) (1 diff)
• src/wp-includes/deprecated.php (modified) (1 diff)
• src/wp-includes/media.php (modified) (5 diffs)
• src/wp-includes/post.php (modified) (2 diffs)
• tests/phpunit/tests/media.php (modified) (1 diff)

trunk/src/wp-includes/customize/class-wp-customize-media-control.php

@@ -100 +100 @@
                     'url'   => $this->setting->default,
                     'type'  => $type,
-                    'icon'  => wp_mime_type_icon( $type ),
+                    'icon'  => wp_mime_type_icon( $type, '.svg' ),
                     'title' => wp_basename( $this->setting->default ),
                 );

trunk/src/wp-includes/deprecated.php

@@ -1911 +1911 @@
         $src = wp_get_attachment_url( $post->ID );
         $src_file = & $file;
-    } elseif ( $src = wp_mime_type_icon( $post->ID ) ) {
+    } elseif ( $src = wp_mime_type_icon( $post->ID, '.svg' ) ) {
         // No thumb, no image. We'll look for a mime-related icon instead.
 

trunk/src/wp-includes/media.php

@@ -973 +973 @@
 
         if ( $icon ) {
-            $src = wp_mime_type_icon( $attachment_id );
+            $src = wp_mime_type_icon( $attachment_id, '.svg' );
 
             if ( $src ) {
@@ -979 +979 @@
                 $icon_dir = apply_filters( 'icon_dir', ABSPATH . WPINC . '/images/media' );
 
-                $src_file               = $icon_dir . '/' . wp_basename( $src );
+                $src_file = $icon_dir . '/' . wp_basename( $src );
                 list( $width, $height ) = wp_getimagesize( $src_file );
+                $ext      = strtolower( substr( $src_file, -4 ) );
+                if ( '.svg' === $ext ) {
+                    // SVG does not have true dimensions, so this assigns width and height directly.
+                    $width  = 48;
+                    $height = 64;
+                } else {
+                    list( $width, $height ) = wp_getimagesize( $src_file );
+                }
             }
         }
@@ -3068 +3076 @@
                 $track['thumb']               = compact( 'src', 'width', 'height' );
             } else {
-                $src            = wp_mime_type_icon( $attachment->ID );
+                $src            = wp_mime_type_icon( $attachment->ID, '.svg' );
                 $width          = 48;
                 $height         = 64;
@@ -4340 +4348 @@
         'type'          => $type,
         'subtype'       => $subtype,
-        'icon'          => wp_mime_type_icon( $attachment->ID ),
+        'icon'          => wp_mime_type_icon( $attachment->ID, '.svg' ),
         'dateFormatted' => mysql2date( __( 'F j, Y' ), $attachment->post_date ),
         'nonces'        => array(
@@ -4511 +4519 @@
             $response['thumb']            = compact( 'src', 'width', 'height' );
         } else {
-            $src               = wp_mime_type_icon( $attachment->ID );
+            $src               = wp_mime_type_icon( $attachment->ID, '.svg' );
             $width             = 48;
             $height            = 64;

trunk/src/wp-includes/post.php

@@ -6804 +6804 @@
  * @since 2.1.0
  *
- * @param string|int $mime MIME type or attachment ID.
+ * @param string|int $mime          MIME type or attachment ID.
+ * @param string     $preferred_ext File format to prefer in return. Default .png.
  * @return string|false Icon, false otherwise.
  */
-function wp_mime_type_icon( $mime = 0 ) {
+function wp_mime_type_icon( $mime = 0, $preferred_ext = '.png' ) {
     if ( ! is_numeric( $mime ) ) {
         $icon = wp_cache_get( "mime_type_icon_$mime" );
@@ -6886 +6887 @@
                             continue;
                         }
-                        $icon_files[ "$dir/$file" ] = "$uri/$file";
+                        if ( $ext === $preferred_ext ) {
+                            $icon_files[ "$dir/$file" ] = "$uri/$file";
+                        }
                     }
                     closedir( $dh );

trunk/tests/phpunit/tests/media.php

@@ -400 +400 @@
         // #21963, there will be a GUID always, so there will be a URL.
         $this->assertNotEquals( '', $prepped['url'] );
-        $this->assertSame( site_url( 'wp-includes/images/media/default.png' ), $prepped['icon'] );
+        $this->assertSame( site_url( 'wp-includes/images/media/default.svg' ), $prepped['icon'] );
 
         // Fake a mime.