Changeset 46353 for trunk/src/wp-includes/post.php

Timestamp:

09/30/2019 04:27:11 PM (5 years ago)

Author:

azaozz

Message:

Media: Move wp_get_original_image_path() to wp-content/post.php to make it easier to access from plugins.

Props pbiron.
See #47873.

File:

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

trunk/src/wp-includes/post.php

@@ -7141 +7141 @@
     return $types;
 }
+
+/**
+ * Retrieves the path to an uploaded image file.
+ *
+ * Similar to `get_attached_file()` however some images may have been processed after uploading
+ * to make them suitable for web use. In this case the attached "full" size file is usually replaced
+ * with a scaled down version of the original image. This function always returns the path
+ * to the originally uploaded image file.
+ *
+ * @since 5.3.0
+ *
+ * @param int $attachment_id Attachment ID.
+ * @return string|false Path to the original image file or false if the attachment is not an image.
+ */
+function wp_get_original_image_path( $attachment_id ) {
+    if ( ! wp_attachment_is_image( $attachment_id ) ) {
+        return false;
+    }
+
+    $image_meta = wp_get_attachment_metadata( $attachment_id );
+    $image_file = get_attached_file( $attachment_id );
+
+    if ( empty( $image_meta['original_image'] ) ) {
+        $original_image = $image_file;
+    } else {
+        $original_image = path_join( dirname( $image_file ), $image_meta['original_image'] );
+    }
+
+    /**
+     * Filters the path to the original image.
+     *
+     * @since 5.3.0
+     *
+     * @param string $original_image Path to original image file.
+     * @param int    $attachment_id  Attachment ID.
+     */
+    return apply_filters( 'wp_get_original_image_path', $original_image, $attachment_id );
+}