Changeset 55437

Timestamp:

03/01/2023 12:34:18 AM (19 months ago)

Author:

azaozz

Message:

Media: Revert the addition of a $size parameter to get_attached_file().

Reverts [55199], [55202], and [55217] but keeps the updated docs.

Props: flixos90, joedolson, azaozz.
Fixes: #51780.

Location:

trunk

Files:

• src/wp-includes/post.php (modified) (3 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 the `$size` parameter is provided.
- *
  * By default the path will go through the {@see 'get_attached_file'} filter, but
  * passing `true` to the `$unfiltered` argument will return the file path unfiltered.
@@ -716 +714 @@
  *
  * @since 2.0.0
- * @since 6.2.0 The `$size` parameter was added.
- *
- * @param int          $attachment_id Attachment ID.
- * @param bool         $unfiltered    Optional. Whether to skip the {@see 'get_attached_file'} filter.
- *                                    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 empty string.
+ *
+ * @param int  $attachment_id Attachment ID.
+ * @param bool $unfiltered    Optional. Whether to skip the {@see 'get_attached_file'} filter.
+ *                            Default false.
  * @return string|false The file path to where the attached file should be, false otherwise.
  */
-function get_attached_file( $attachment_id, $unfiltered = false, $size = '' ) {
-
-    // Check for intermediate sizes first, otherwise fall back to the 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 );
-    }
+function get_attached_file( $attachment_id, $unfiltered = false ) {
+    $file = get_post_meta( $attachment_id, '_wp_attached_file', true );
 
     // If the file is relative, prepend upload dir.
@@ -755 +739 @@
      *
      * @since 2.1.0
-     * @since 6.2.0 The `$size` parameter was added.
      *
      * @param string|false $file          The file path to where the attached file should be, false otherwise.
      * @param int          $attachment_id Attachment ID.
-     * @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 empty string.
      */
-    return apply_filters( 'get_attached_file', $file, $attachment_id, $size );
+    return apply_filters( 'get_attached_file', $file, $attachment_id );
 }
 

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

@@ -19 +19 @@
      *
      * @ticket 49412
-     * @ticket 51780
      *
      * @covers ::wp_create_image_subsizes
@@ -30 +29 @@
         $this->assertSame( wp_filesize( get_attached_file( $attachment ) ), $metadata['filesize'] );
 
-        foreach ( $metadata['sizes'] as $size => $intermediate_size ) {
+        foreach ( $metadata['sizes'] as $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 ) );
         }
     }