Changeset 53685 for trunk/src/wp-includes/deprecated.php

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.

File:

• trunk/src/wp-includes/deprecated.php (modified) (1 diff)

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;
+}