_wp_image_meta_replace_original( array $saved_data, string $original_file, array $image_meta, int $attachment_id ): array

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$saved_dataarray

The data returned from WP_Image_Editor after successfully saving an image.

$original_filestring

Path to the original file.

$image_metaarray

The image meta data.

$attachment_idint

The attachment post ID.

Return value

array

The updated image meta data.

Performance profile

How much work a call to _wp_image_meta_replace_original() 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

Reaches the database via get_post().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

31

Executed per call on PHP 8.5. The body compiles to 31.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• querycontent queryget_post()one call below _wp_image_meta_replace_original()
• hookthird-party callbacksapply_filters()one call below _wp_image_meta_replace_original()

Further down the call graph this can also reach serialize, cache, 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 · 1 distinct outcome

One number would be a lie: the work depends on which branch runs. These are every distinct cost _wp_image_meta_replace_original() can have, taken from its control-flow graph on PHP 8.5.

Uses · 4

• update_attached_file()Updates attachment file path based on attachment ID.
• _wp_relative_upload_path()Returns relative path to an uploaded file.
• wp_filesize()Wrapper for PHP filesize with filters and casting the result as an integer.
• wp_basename()i18n-friendly version of basename().

Used by · 1

• wp_create_image_subsizes()Creates image sub-sizes, adds the new data to the image meta `sizes` array, and updates the image metadata.

Source code

View on Trac ↗View on GitHub ↗

206function _wp_image_meta_replace_original( $saved_data, $original_file, $image_meta, $attachment_id ) {207	$new_file = $saved_data['path'];208 209	// Update the attached file meta.210	update_attached_file( $attachment_id, $new_file );211 212	// Width and height of the new image.213	$image_meta['width']  = $saved_data['width'];214	$image_meta['height'] = $saved_data['height'];215 216	// Make the file path relative to the upload dir.217	$image_meta['file'] = _wp_relative_upload_path( $new_file );218 219	// Add image file size.220	$image_meta['filesize'] = wp_filesize( $new_file );221 222	// Store the original image file name in image_meta.223	$image_meta['original_image'] = wp_basename( $original_file );224 225	return $image_meta;226}

Changelog

Introduced in 5.3.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-admin/includes/image.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.