wp_get_original_image_url( int $attachment_id ): string|false
Retrieves the URL to an original attachment image.
Contents
Description
Similar to wp_get_attachment_url()
however some images may have been processed after uploading. In this case this function returns the URL to the originally uploaded image file.
Parameters
-
$attachment_id
int Required -
Attachment post ID.
Return
string|false Attachment image URL, false on error or if the attachment is not an image.
Source
File: wp-includes/post.php
.
View all references
function wp_get_original_image_url( $attachment_id ) {
if ( ! wp_attachment_is_image( $attachment_id ) ) {
return false;
}
$image_url = wp_get_attachment_url( $attachment_id );
if ( ! $image_url ) {
return false;
}
$image_meta = wp_get_attachment_metadata( $attachment_id );
if ( empty( $image_meta['original_image'] ) ) {
$original_image_url = $image_url;
} else {
$original_image_url = path_join( dirname( $image_url ), $image_meta['original_image'] );
}
/**
* Filters the URL to the original attachment image.
*
* @since 5.3.0
*
* @param string $original_image_url URL to original image.
* @param int $attachment_id Attachment ID.
*/
return apply_filters( 'wp_get_original_image_url', $original_image_url, $attachment_id );
}
Hooks
-
apply_filters( 'wp_get_original_image_url',
string $original_image_url ,int $attachment_id ) -
Filters the URL to the original attachment image.
Changelog
Version | Description |
---|---|
5.3.0 | Introduced. |