wp_get_original_image_path( int $attachment_id, bool $unfiltered = false ): string|false
- Since
- 5.3.0, 5.4.0
- Source
wp-includes/post.php:8683
Description
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.
Compatibility
- WordPress
- since 5.4.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 ID.
$unfilteredbooloptional- Passed through to
get_attached_file(). Default false.Default:false
Return value
string|false- Path to the original image file or false if the attachment is not an image.
Performance profile
How much work a call to wp_get_original_image_path() 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
- 7–31
- Plugin surface
- 1 hook
- Called by
- 7
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_path' run inside this call, and their cost is not bounded by anything here.
7 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_path()
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 · 3 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_get_original_image_path() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!wp_attachment_is_image() | 7 | wp_attachment_is_image() |
wp_attachment_is_image() && empty($image_meta) | 25 | wp_attachment_is_image(), wp_get_attachment_metadata(), get_attached_file(), apply_filters() |
wp_attachment_is_image() && !empty($image_meta) | 31 | wp_attachment_is_image(), wp_get_attachment_metadata(), get_attached_file(), path_join(), apply_filters() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 34 | 7–31 | 2 | |
| 8.5 | 34 | 7–31 | 2 | |
| 8.4 | 34 | 7–31 | 2 | 2 fewer instructions than PHP 8.3 |
| 8.3 | 36 | 7–33 | 2 | |
| 8.2 | 36 | 7–33 | 2 | |
| 8.1 | 36 | 7–33 | 2 | |
| 7.4 | 36 | 7–33 | 2 |
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_path() runs, in this order:
- apply_filters( wp_get_original_image_path )filterline 8705 (+22 into the body)
Filters the path to the original image.
Uses · 5
- wp_attachment_is_image()Determines whether an attachment is an image.
- wp_get_attachment_metadata()Retrieves attachment metadata for attachment ID.
- get_attached_file()Retrieves attached file path based on 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 · 7
- WP_REST_Attachments_Controller::edit_media_item()Applies edits to a media item and creates a new attachment record.
- WP_REST_Attachments_Controller::get_attachment_filename()Gets the attachment's original file name.
- WP_REST_Attachments_Controller::get_attachment_filesize()Gets the attachment's file size in bytes.
- attachment_submitbox_metadata()Displays non-editable attachment metadata in the publish meta box.
- wp_get_missing_image_subsizes()Compare the existing image sub-sizes (as saved in the attachment meta) to the currently registered image sub-sizes, and return the difference.
- 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.
- wp_update_image_subsizes()If any of the currently registered image sub-sizes are missing, create them and update the image meta data.
Source code
function wp_get_original_image_path( $attachment_id, $unfiltered = false ) { if ( ! wp_attachment_is_image( $attachment_id ) ) { return false; } $image_meta = wp_get_attachment_metadata( $attachment_id ); $image_file = get_attached_file( $attachment_id, $unfiltered ); 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 );}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.
$unfiltered parameter.from the docblockAbout this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 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.