wp_restore_image( int $post_id ): stdClass

Compatibility

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

Parameters

$post_idint

Attachment post ID.

Return value

stdClass

Image restoration message object.

Performance profile

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

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

28–133

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 211.

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_restore_image()
• hookthird-party callbacksapply_filters()one call below wp_restore_image()

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 · 13 distinct outcomes

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

Uses · 13

• wp_get_attachment_metadata()Retrieves attachment metadata for attachment ID.
• get_attached_file()Retrieves attached file path based on attachment ID.
• get_post_meta()Retrieves a post meta field for the given post ID.
• __()Retrieves the translation of $text.
• get_intermediate_image_sizes()Gets the available intermediate image size names.
• wp_delete_file()Deletes a file.
• path_join()Joins two filesystem paths together.
• update_attached_file()Updates attachment file path based on attachment ID.
• _wp_relative_upload_path()Returns relative path to an uploaded file.
• wp_update_attachment_metadata()Updates metadata for an attachment.
• update_post_meta()Updates a post meta field based on the given post ID.
• delete_post_meta()Deletes a post meta field for the given post ID.

Used by · 1

• wp_ajax_image_editor()Handles image editing via AJAX.

Source code

View on Trac ↗View on GitHub ↗

815function wp_restore_image( $post_id ) {816	$meta             = wp_get_attachment_metadata( $post_id );817	$file             = get_attached_file( $post_id );818	$backup_sizes     = get_post_meta( $post_id, '_wp_attachment_backup_sizes', true );819	$old_backup_sizes = $backup_sizes;820	$restored         = false;821	$msg              = new stdClass();822 823	if ( ! is_array( $meta ) || ! is_array( $backup_sizes ) ) {824		$msg->error = __( 'Cannot load image metadata.' );825		return $msg;826	}827 828	$meta['sizes'] ??= array();829 830	$parts         = pathinfo( $file );831	$suffix        = time() . rand( 100, 999 );832	$default_sizes = get_intermediate_image_sizes();833 834	if ( isset( $backup_sizes['full-orig'] ) && is_array( $backup_sizes['full-orig'] ) ) {835		$data = $backup_sizes['full-orig'];836 837		if ( $parts['basename'] !== $data['file'] ) {838			if ( defined( 'IMAGE_EDIT_OVERWRITE' ) && IMAGE_EDIT_OVERWRITE ) {839				// Delete only if it's an edited image.840				if ( preg_match( '/-e[0-9]{13}\./', $parts['basename'] ) ) {841					wp_delete_file( $file );842				}843			} elseif ( isset( $meta['width'], $meta['height'] ) ) {844				$backup_sizes[ "full-$suffix" ] = array(845					'width'    => $meta['width'],846					'height'   => $meta['height'],847					'filesize' => $meta['filesize'],848					'file'     => $parts['basename'],849				);850			}851		}852 853		$restored_file = path_join( $parts['dirname'], $data['file'] );854		$restored      = update_attached_file( $post_id, $restored_file );855 856		$meta['file']   = _wp_relative_upload_path( $restored_file );857		$meta['width']  = $data['width'];858		$meta['height'] = $data['height'];859		if ( isset( $data['filesize'] ) ) {860			/*861			 * Restore the original filesize if it was backed up.862			 *863			 * See https://core.trac.wordpress.org/ticket/59684.864			 */865			$meta['filesize'] = $data['filesize'];866		}867	}868 869	foreach ( $default_sizes as $default_size ) {870		if ( isset( $backup_sizes[ "$default_size-orig" ] ) ) {871			$data = $backup_sizes[ "$default_size-orig" ];872 873			if ( isset( $meta['sizes'][ $default_size ] ) && $meta['sizes'][ $default_size ]['file'] !== $data['file'] ) {874				if ( defined( 'IMAGE_EDIT_OVERWRITE' ) && IMAGE_EDIT_OVERWRITE ) {875					// Delete only if it's an edited image.876					if ( preg_match( '/-e[0-9]{13}-/', $meta['sizes'][ $default_size ]['file'] ) ) {877						$delete_file = path_join( $parts['dirname'], $meta['sizes'][ $default_size ]['file'] );878						wp_delete_file( $delete_file );879					}880				} else {881					$backup_sizes[ "$default_size-{$suffix}" ] = $meta['sizes'][ $default_size ];882				}883			}884 885			$meta['sizes'][ $default_size ] = $data;886		} else {887			unset( $meta['sizes'][ $default_size ] );888		}889	}890 891	if ( ! wp_update_attachment_metadata( $post_id, $meta )892		|| ( $old_backup_sizes !== $backup_sizes && ! update_post_meta( $post_id, '_wp_attachment_backup_sizes', $backup_sizes ) )893	) {894		$msg->error = __( 'Cannot save image metadata.' );

Changelog

Introduced in 2.9.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-edit.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.