<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[57687] trunk: Media: Ensure `wp_mine_type_icon()` returns expected file type.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/57687">57687</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/57687","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>joedolson</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-02-21 19:25:18 +0000 (Wed, 21 Feb 2024)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="https://core.trac.wordpress.org/changeset/57638">[57638]</a>, 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 <a href="https://core.trac.wordpress.org/changeset/57638">[57638]</a>.
Also handles a missed case in media list view.
Props SergeyBiryukov, sabernhardt, joedolson, antpb.
Fixes <a href="https://core.trac.wordpress.org/ticket/31352">#31352</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludescustomizeclasswpcustomizemediacontrolphp">trunk/src/wp-includes/customize/class-wp-customize-media-control.php</a></li>
<li><a href="#trunksrcwpincludesdeprecatedphp">trunk/src/wp-includes/deprecated.php</a></li>
<li><a href="#trunksrcwpincludesmediaphp">trunk/src/wp-includes/media.php</a></li>
<li><a href="#trunksrcwpincludespostphp">trunk/src/wp-includes/post.php</a></li>
<li><a href="#trunktestsphpunittestsmediaphp">trunk/tests/phpunit/tests/media.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludescustomizeclasswpcustomizemediacontrolphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/customize/class-wp-customize-media-control.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/customize/class-wp-customize-media-control.php 2024-02-21 19:24:14 UTC (rev 57686)
+++ trunk/src/wp-includes/customize/class-wp-customize-media-control.php 2024-02-21 19:25:18 UTC (rev 57687)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -99,7 +99,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'id' => 1,
</span><span class="cx" style="display: block; padding: 0 10px"> 'url' => $this->setting->default,
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => $type,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'icon' => wp_mime_type_icon( $type ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'icon' => wp_mime_type_icon( $type, '.svg' ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'title' => wp_basename( $this->setting->default ),
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunksrcwpincludesdeprecatedphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/deprecated.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/deprecated.php 2024-02-21 19:24:14 UTC (rev 57686)
+++ trunk/src/wp-includes/deprecated.php 2024-02-21 19:25:18 UTC (rev 57687)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1910,7 +1910,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $src = wp_get_attachment_url( $post->ID );
</span><span class="cx" style="display: block; padding: 0 10px"> $src_file = & $file;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- } elseif ( $src = wp_mime_type_icon( $post->ID ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } elseif ( $src = wp_mime_type_icon( $post->ID, '.svg' ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> // No thumb, no image. We'll look for a mime-related icon instead.
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /** This filter is documented in wp-includes/post.php */
</span></span></pre></div>
<a id="trunksrcwpincludesmediaphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/media.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/media.php 2024-02-21 19:24:14 UTC (rev 57686)
+++ trunk/src/wp-includes/media.php 2024-02-21 19:25:18 UTC (rev 57687)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -972,14 +972,22 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $src = false;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $icon ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $src = wp_mime_type_icon( $attachment_id );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $src = wp_mime_type_icon( $attachment_id, '.svg' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $src ) {
</span><span class="cx" style="display: block; padding: 0 10px"> /** This filter is documented in wp-includes/post.php */
</span><span class="cx" style="display: block; padding: 0 10px"> $icon_dir = apply_filters( 'icon_dir', ABSPATH . WPINC . '/images/media' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $src_file = $icon_dir . '/' . wp_basename( $src );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $src_file = $icon_dir . '/' . wp_basename( $src );
</ins><span class="cx" style="display: block; padding: 0 10px"> list( $width, $height ) = wp_getimagesize( $src_file );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $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 );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3067,7 +3075,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> list( $src, $width, $height ) = wp_get_attachment_image_src( $thumb_id, 'thumbnail' );
</span><span class="cx" style="display: block; padding: 0 10px"> $track['thumb'] = compact( 'src', 'width', 'height' );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $src = wp_mime_type_icon( $attachment->ID );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $src = wp_mime_type_icon( $attachment->ID, '.svg' );
</ins><span class="cx" style="display: block; padding: 0 10px"> $width = 48;
</span><span class="cx" style="display: block; padding: 0 10px"> $height = 64;
</span><span class="cx" style="display: block; padding: 0 10px"> $track['image'] = compact( 'src', 'width', 'height' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4339,7 +4347,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'mime' => $attachment->post_mime_type,
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => $type,
</span><span class="cx" style="display: block; padding: 0 10px"> 'subtype' => $subtype,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'icon' => wp_mime_type_icon( $attachment->ID ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'icon' => wp_mime_type_icon( $attachment->ID, '.svg' ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'dateFormatted' => mysql2date( __( 'F j, Y' ), $attachment->post_date ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'nonces' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'update' => false,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4510,7 +4518,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> list( $src, $width, $height ) = wp_get_attachment_image_src( $id, 'thumbnail' );
</span><span class="cx" style="display: block; padding: 0 10px"> $response['thumb'] = compact( 'src', 'width', 'height' );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $src = wp_mime_type_icon( $attachment->ID );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $src = wp_mime_type_icon( $attachment->ID, '.svg' );
</ins><span class="cx" style="display: block; padding: 0 10px"> $width = 48;
</span><span class="cx" style="display: block; padding: 0 10px"> $height = 64;
</span><span class="cx" style="display: block; padding: 0 10px"> $response['image'] = compact( 'src', 'width', 'height' );
</span></span></pre></div>
<a id="trunksrcwpincludespostphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/post.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/post.php 2024-02-21 19:24:14 UTC (rev 57686)
+++ trunk/src/wp-includes/post.php 2024-02-21 19:25:18 UTC (rev 57687)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -6803,10 +6803,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.1.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string|int $mime MIME type or attachment ID.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string|int $mime MIME type or attachment ID.
+ * @param string $preferred_ext File format to prefer in return. Default .png.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string|false Icon, false otherwise.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function wp_mime_type_icon( $mime = 0 ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function wp_mime_type_icon( $mime = 0, $preferred_ext = '.png' ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_numeric( $mime ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $icon = wp_cache_get( "mime_type_icon_$mime" );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -6885,7 +6886,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> continue;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $icon_files[ "$dir/$file" ] = "$uri/$file";
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $ext === $preferred_ext ) {
+ $icon_files[ "$dir/$file" ] = "$uri/$file";
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> closedir( $dh );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestsmediaphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/media.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/media.php 2024-02-21 19:24:14 UTC (rev 57686)
+++ trunk/tests/phpunit/tests/media.php 2024-02-21 19:25:18 UTC (rev 57687)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -399,7 +399,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( '', $prepped['subtype'] );
</span><span class="cx" style="display: block; padding: 0 10px"> // #21963, there will be a GUID always, so there will be a URL.
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertNotEquals( '', $prepped['url'] );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertSame( site_url( 'wp-includes/images/media/default.png' ), $prepped['icon'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertSame( site_url( 'wp-includes/images/media/default.svg' ), $prepped['icon'] );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Fake a mime.
</span><span class="cx" style="display: block; padding: 0 10px"> $post->post_mime_type = 'image/jpeg';
</span></span></pre>
</div>
</div>
</body>
</html>