wp_get_original_image_url( int $attachment_id ): string|false
- Since
- 5.3.0
- Source
wp-includes/post.php:8497
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.
Compatibility
- WordPress
- since 5.3.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$attachment_idint- Attachment post ID.
Return value
string|false- Attachment image URL, false on error or if the attachment is not an image.
Performance profile
How much work a call to wp_get_original_image_url() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Heavy
- Scaling
- Constant
- Instructions
- 6–30
- Plugin surface
- 1 hook
- Called by
- 2
Reaches the database via get_post().
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 34.
Third-party callbacks on 'wp_get_original_image_url' run inside this call, and their cost is not bounded by anything here.
2 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()called directly - querycontent query
get_post()one call below wp_get_original_image_url()
Further down the call graph this can also reach cache, serialize, option and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 4 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_get_original_image_url() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!wp_attachment_is_image() | 6 | wp_attachment_is_image() |
wp_attachment_is_image() | 11 | wp_attachment_is_image(), wp_get_attachment_url() |
wp_attachment_is_image() && empty($image_meta) | 24 | wp_attachment_is_image(), wp_get_attachment_url(), wp_get_attachment_metadata(), apply_filters() |
wp_attachment_is_image() && !empty($image_meta) | 30 | wp_attachment_is_image(), wp_get_attachment_url(), wp_get_attachment_metadata(), path_join(), apply_filters() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 34 | 6–30 | 3 | |
| 8.5 | 34 | 6–30 | 3 | |
| 8.4 | 34 | 6–30 | 3 | 2 fewer instructions than PHP 8.3 |
| 8.3 | 36 | 6–32 | 3 | |
| 8.2 | 36 | 6–32 | 3 | |
| 8.1 | 36 | 6–32 | 3 | |
| 7.4 | 36 | 6–32 | 3 |
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Hooks and filters fired · 1
One hook fires while wp_get_original_image_url() runs, in this order:
- apply_filters( wp_get_original_image_url )filterline 8524 (+27 into the body)
Filters the URL to the original attachment image.
Uses · 5
- wp_attachment_is_image()Determines whether an attachment is an image.
- wp_get_attachment_url()Retrieves the URL for an attachment.
- wp_get_attachment_metadata()Retrieves attachment metadata for attachment ID.
- path_join()Joins two filesystem paths together.
- apply_filters()Calls the callback functions that have been added to a filter hook.
Used by · 2
- attachment_submitbox_metadata()Displays non-editable attachment metadata in the publish meta box.
- wp_prepare_attachment_for_js()Prepares an attachment post object for JS, where it is expected to be JSON-encoded and fit into an Attachment model.
Source code
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 );}Changelog
Introduced in 5.3.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.0.4 tag, from
src/wp-includes/post.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.