Changeset 55199

Timestamp:

02/02/2023 11:38:49 PM (20 months ago)

Author:

joedolson

Message:

Media: Add argument to get_attached_file() for subsizes.

Add a $size argument to get_attached_file() to simplify getting the path to an intermediate image size.

Props paulschreiber, audrasjb, Mista-Flo.
Fixes #51780.

Location:

trunk

Files:

• src/wp-includes/post.php (modified) (2 diffs)
• tests/phpunit/tests/media/wpGenerateAttachmentMetadata.php (modified) (2 diffs)

trunk/src/wp-includes/post.php

@@ -706 +706 @@
  * Retrieves attached file path based on attachment ID.
  *
+ * Will return intermediate size path if $size param is provided.
+ *
  * By default the path will go through the 'get_attached_file' filter, but
  * passing a true to the $unfiltered argument of get_attached_file() will
@@ -716 +718 @@
  *
  * @since 2.0.0
- *
- * @param int  $attachment_id Attachment ID.
- * @param bool $unfiltered    Optional. Whether to apply filters. Default false.
+ * @since 6.2 The `$size` parameter was added
+ *
+ * @param int          $attachment_id Attachment ID.
+ * @param bool         $unfiltered    Optional. Whether to apply filters. Default false.
+ * @param string|int[] $size          Optional. Image size. Accepts any registered image size name, or an array
+ *                                    of width and height values in pixels (in that order). Default ''.
+ *
  * @return string|false The file path to where the attached file should be, false otherwise.
  */
-function get_attached_file( $attachment_id, $unfiltered = false ) {
-    $file = get_post_meta( $attachment_id, '_wp_attached_file', true );
+function get_attached_file( $attachment_id, $unfiltered = false, $size = '' ) {
+
+    // Check for intermediate sizes first, otherwise fallback to original attachment size
+    if ( ! empty( $size ) ) {
+        $intermediate_image = image_get_intermediate_size( $attachment_id, $size );
+        if ( ! $intermediate_image || ! isset( $intermediate_image['path'] ) ) {
+            return false;
+        }
+        $file = $intermediate_image['path'];
+    } else {
+        $file = get_post_meta( $attachment_id, '_wp_attached_file', true );
+    }
 
     // If the file is relative, prepend upload dir.

trunk/tests/phpunit/tests/media/wpGenerateAttachmentMetadata.php

@@ -19 +19 @@
      *
      * @ticket 49412
+     * @ticket 51780
      *
      * @covers ::wp_create_image_subsizes
@@ -29 +30 @@
         $this->assertSame( wp_filesize( get_attached_file( $attachment ) ), $metadata['filesize'] );
 
-        foreach ( $metadata['sizes'] as $intermediate_size ) {
+        foreach ( $metadata['sizes'] as $size => $intermediate_size ) {
             $this->assertArrayHasKey( 'filesize', $intermediate_size );
             $this->assertNotEmpty( $intermediate_size['filesize'] );
             $this->assertIsNumeric( $intermediate_size['filesize'] );
+            $this->assertStringContainsString( $intermediate_size['file'], get_attached_file( $attachment, false, $size ) );
         }
     }