Changeset 53685

Timestamp:

07/07/2022 11:30:21 PM (4 years ago)

Author:

azaozz

Message:

Media:

• Deprecate wp_get_attachment_thumb_file().
• Make wp_get_attachment_thumb_url() an alias of wp_get_attachment_image_url(). This fixes it to return the proper thumbnail URL and fall back to returning the URL to image_meta['thumb'] if only that exists.

Props: markhowellsmead, mukesh27, csesumonpro, SergeyBiryukov, mikeschroder, killua99, joemcgill, mashukushibiki, mfgmicha, swissspidy, romulodl, nacin, JoshuaAbenazer, wonderboymusic, lonnylot, azaozz.

Location:

trunk/src/wp-includes

Files:

• deprecated.php (modified) (1 diff)
• media.php (modified) (1 diff)
• post.php (modified) (3 diffs)

trunk/src/wp-includes/deprecated.php

@@ -4312 +4312 @@
         _deprecated_function( __FUNCTION__, '6.0.0' );
 }
+
+/**
+ * Retrieves thumbnail for an attachment.
+ * Note that this works only for the (very) old image metadata style where 'thumb' was set,
+ * and the 'sizes' array did not exist. This function returns false for the newer image metadata style
+ * despite that 'thumbnail' is present in the 'sizes' array.
+ *
+ * @since 2.1.0
+ * @deprecated 6.1.0
+ *
+ * @param int $post_id Optional. Attachment ID. Default is the ID of the global `$post`.
+ * @return string|false Thumbnail file path on success, false on failure.
+ */
+function wp_get_attachment_thumb_file( $post_id = 0 ) {
+        _deprecated_function( __FUNCTION__, '6.1.0' );
+
+        $post_id = (int) $post_id;
+        $post    = get_post( $post_id );
+
+        if ( ! $post ) {
+                return false;
+        }
+
+        // Use $post->ID rather than $post_id as get_post() may have used the global $post object.
+        $imagedata = wp_get_attachment_metadata( $post->ID );
+
+        if ( ! is_array( $imagedata ) ) {
+                return false;
+        }
+
+        $file = get_attached_file( $post->ID );
+
+        if ( ! empty( $imagedata['thumb'] ) ) {
+                $thumbfile = str_replace( wp_basename( $file ), $imagedata['thumb'], $file );
+                if ( file_exists( $thumbfile ) ) {
+                        /**
+                         * Filters the attachment thumbnail file path.
+                         *
+                         * @since 2.1.0
+                         *
+                         * @param string $thumbfile File path to the attachment thumbnail.
+                         * @param int    $post_id   Attachment ID.
+                         */
+                        return apply_filters( 'wp_get_attachment_thumb_file', $thumbfile, $post->ID );
+                }
+        }
+
+        return false;
+}

trunk/src/wp-includes/media.php

@@ -239 +239 @@
                 $height          = $intermediate['height'];
                 $is_intermediate = true;
-        } elseif ( 'thumbnail' === $size ) {
+        } elseif ( 'thumbnail' === $size && ! empty( $meta['thumb'] ) && is_string( $meta['thumb'] ) ) {
                 // Fall back to the old thumbnail.
-                $thumb_file = wp_get_attachment_thumb_file( $id );
-                $info       = null;
-
-                if ( $thumb_file ) {
-                        $info = wp_getimagesize( $thumb_file );
-                }
-
-                if ( $thumb_file && $info ) {
-                        $img_url         = str_replace( $img_url_basename, wp_basename( $thumb_file ), $img_url );
-                        $width           = $info[0];
-                        $height          = $info[1];
-                        $is_intermediate = true;
+                $imagefile = get_attached_file( $id );
+                $thumbfile = str_replace( wp_basename( $imagefile ), wp_basename( $meta['thumb'] ), $imagefile );
+
+                if ( file_exists( $thumbfile ) ) {
+                        $info = wp_getimagesize( $thumbfile );
+
+                        if ( $info ) {
+                                $img_url         = str_replace( $img_url_basename, wp_basename( $thumbfile ), $img_url );
+                                $width           = $info[0];
+                                $height          = $info[1];
+                                $is_intermediate = true;
+                        }
                 }
         }

trunk/src/wp-includes/post.php

@@ -6703 +6703 @@
 
 /**
- * Retrieves thumbnail for an attachment.
+ * Retrieves URL for an attachment thumbnail.
  *
  * @since 2.1.0
- *
- * @param int $post_id Optional. Attachment ID. Default is the ID of the global `$post`.
- * @return string|false Thumbnail file path on success, false on failure.
- */
-function wp_get_attachment_thumb_file( $post_id = 0 ) {
-        $post_id = (int) $post_id;
-        $post    = get_post( $post_id );
-
-        if ( ! $post ) {
-                return false;
-        }
-
-        $imagedata = wp_get_attachment_metadata( $post->ID );
-        if ( ! is_array( $imagedata ) ) {
-                return false;
-        }
-
-        $file = get_attached_file( $post->ID );
-
-        if ( ! empty( $imagedata['thumb'] ) ) {
-                $thumbfile = str_replace( wp_basename( $file ), $imagedata['thumb'], $file );
-                if ( file_exists( $thumbfile ) ) {
-                        /**
-                         * Filters the attachment thumbnail file path.
-                         *
-                         * @since 2.1.0
-                         *
-                         * @param string $thumbfile File path to the attachment thumbnail.
-                         * @param int    $post_id   Attachment ID.
-                         */
-                        return apply_filters( 'wp_get_attachment_thumb_file', $thumbfile, $post->ID );
-                }
-        }
-        return false;
-}
-
-/**
- * Retrieves URL for an attachment thumbnail.
- *
- * @since 2.1.0
+ * @since 6.1.0 Changed to use wp_get_attachment_image_url().
  *
  * @param int $post_id Optional. Attachment ID. Default is the ID of the global `$post`.
@@ -6752 +6713 @@
 function wp_get_attachment_thumb_url( $post_id = 0 ) {
         $post_id = (int) $post_id;
-        $post    = get_post( $post_id );
-
-        if ( ! $post ) {
+
+        // This uses image_downsize() which also looks for the (very) old format $image_meta['thumb']
+        // when the newer format $image_meta['sizes']['thumbnail'] doesn't exist.
+        $thumbnail_url = wp_get_attachment_image_url( $post_id, 'thumbnail' );
+
+        if ( empty( $thumbnail_url ) ) {
                 return false;
         }
-
-        $url = wp_get_attachment_url( $post->ID );
-        if ( ! $url ) {
-                return false;
-        }
-
-        $sized = image_downsize( $post_id, 'thumbnail' );
-        if ( $sized ) {
-                return $sized[0];
-        }
-
-        $thumb = wp_get_attachment_thumb_file( $post->ID );
-        if ( ! $thumb ) {
-                return false;
-        }
-
-        $url = str_replace( wp_basename( $url ), wp_basename( $thumb ), $url );
 
         /**
@@ -6780 +6727 @@
          * @since 2.1.0
          *
-         * @param string $url     URL for the attachment thumbnail.
-         * @param int    $post_id Attachment ID.
+         * @param string $thumbnail_url URL for the attachment thumbnail.
+         * @param int    $post_id       Attachment ID.
          */
-        return apply_filters( 'wp_get_attachment_thumb_url', $url, $post->ID );
+        return apply_filters( 'wp_get_attachment_thumb_url', $thumbnail_url, $post_id );
 }