Changeset 50134

Timestamp:

02/02/2021 02:57:22 AM (4 years ago)

Author:

joemcgill

Message:

Media: Add filter to wp_image_src_get_dimensions.

This adds a new filter, wp_image_src_get_dimensions to the wp_image_src_get_dimensions() function to correct the dimensions returned for a file whenever WordPress isn't able to correctly get the dimensions from attachment metadata.

Fixes #51865.

File:

• trunk/src/wp-includes/media.php (modified) (2 diffs)

trunk/src/wp-includes/media.php

@@ -1600 +1600 @@
  */
 function wp_image_src_get_dimensions( $image_src, $image_meta, $attachment_id = 0 ) {
-    if ( ! wp_image_file_matches_image_meta( $image_src, $image_meta, $attachment_id ) ) {
-        return false;
-    }
+    $dimensions = false;
 
     // Is it a full size image?
     if ( strpos( $image_src, $image_meta['file'] ) !== false ) {
-        return array(
+        $dimensions = array(
             (int) $image_meta['width'],
             (int) $image_meta['height'],
@@ -1612 +1610 @@
     }
 
-    if ( ! empty( $image_meta['sizes'] ) ) {
+    if ( ! $dimensions && ! empty( $image_meta['sizes'] ) ) {
         $src_filename = wp_basename( $image_src );
 
         foreach ( $image_meta['sizes'] as $image_size_data ) {
             if ( $src_filename === $image_size_data['file'] ) {
-                return array(
+                $dimensions = array(
                     (int) $image_size_data['width'],
                     (int) $image_size_data['height'],
                 );
+
+                break;
             }
         }
     }
 
-    return false;
+    /**
+     * Filter the 'wp_image_src_get_dimensions' value.
+     *
+     * @since 5.7.0
+     *
+     * @param array|false $dimensions    Array with first element being the width
+     *                                   and second element being the height, or
+     *                                   false if dimensions could not be determined.
+     * @param string      $image_src     The image source file.
+     * @param array       $image_meta    The image meta data as returned by
+     *                                   'wp_get_attachment_metadata()'.
+     * @param int         $attachment_id The image attachment ID. Default 0.
+     */
+    return apply_filters( 'wp_image_src_get_dimensions', $dimensions, $image_src, $image_meta, $attachment_id );
 }