wp_save_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

Performance profile

How much work a call to wp_save_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

Reads or writes the filesystem via file_exists().

Scaling

Scales with input

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

Instructions

65–259

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

Plugin surface

1 hook

Third-party callbacks on 'image_edit_thumbnails_separately' run inside this call, and their cost is not bounded by anything here.

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()called directly
• hookthird-party callbacksapply_filters()called directly
• optionoption read or writeget_option()called directly
• serializeserialisationjson_decode()called directly
• filesystemfilesystem accessfile_exists()called directly
• cacheobject cachewp_cache_get()one call below wp_save_image()

Further down the call graph this can also reach transient. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 21 distinct outcomes

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

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 1

One hook fires while wp_save_image() runs, in this order:

1. 1
   apply_filters( image_edit_thumbnails_separately )filterline 927 (+23 into the body)

   Shows the settings in the Image Editor that allow selecting to edit only the thumbnail of an image.

Uses · 25

• wp_get_additional_image_sizes()Retrieves additional image sizes.
• get_post()Retrieves post data given a post ID or post object.
• wp_get_image_editor()Returns a WP_Image_Editor instance and loads file into it.
• _load_image_to_edit_path()Retrieves the path or URL of an attachment's attached file.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• esc_js()Escapes single quotes, `"`, ``, `&`, and fixes line endings.
• __()Retrieves the translation of $text.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• wp_unslash()Removes slashes from a string or recursively removes slashes from strings within an array.
• image_edit_apply_changes()Performs group of changes on Editor specified.
• wp_get_attachment_metadata()Retrieves attachment metadata for attachment ID.
• get_post_meta()Retrieves 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 ↗

904function wp_save_image( $post_id ) {905	$_wp_additional_image_sizes = wp_get_additional_image_sizes();906 907	$return  = new stdClass();908	$success = false;909	$delete  = false;910	$scaled  = false;911	$nocrop  = false;912	$post    = get_post( $post_id );913 914	$img = wp_get_image_editor( _load_image_to_edit_path( $post_id, 'full' ) );915 916	if ( is_wp_error( $img ) ) {917		$return->error = esc_js( __( 'Unable to create new image.' ) );918		return $return;919	}920 921	$full_width  = ! empty( $_REQUEST['fwidth'] ) ? (int) $_REQUEST['fwidth'] : 0;922	$full_height = ! empty( $_REQUEST['fheight'] ) ? (int) $_REQUEST['fheight'] : 0;923	$target      = ! empty( $_REQUEST['target'] ) ? preg_replace( '/[^a-z0-9_-]+/i', '', $_REQUEST['target'] ) : '';924	$scale       = ! empty( $_REQUEST['do'] ) && 'scale' === $_REQUEST['do'];925 926	/** This filter is documented in wp-admin/includes/image-edit.php */927	$edit_thumbnails_separately = (bool) apply_filters( 'image_edit_thumbnails_separately', false );928 929	if ( $scale ) {930		$size            = $img->get_size();931		$original_width  = $size['width'];932		$original_height = $size['height'];933 934		if ( $full_width > $original_width || $full_height > $original_height ) {935			$return->error = esc_js( __( 'Images cannot be scaled to a size larger than the original.' ) );936			return $return;937		}938 939		if ( $full_width > 0 && $full_height > 0 ) {940			// Check if it has roughly the same w / h ratio.941			$diff = round( $original_width / $original_height, 2 ) - round( $full_width / $full_height, 2 );942			if ( -0.1 < $diff && $diff < 0.1 ) {943				// Scale the full size image.944				if ( $img->resize( $full_width, $full_height ) ) {945					$scaled = true;946				}947			}948 949			if ( ! $scaled ) {950				$return->error = esc_js( __( 'Error while saving the scaled image. Please reload the page and try again.' ) );951				return $return;952			}953		}954	} elseif ( ! empty( $_REQUEST['history'] ) ) {955		$changes = json_decode( wp_unslash( $_REQUEST['history'] ) );956		if ( $changes ) {957			$img = image_edit_apply_changes( $img, $changes );958		}959	} else {960		$return->error = esc_js( __( 'Nothing to save, the image has not changed.' ) );961		return $return;962	}963 964	$meta         = wp_get_attachment_metadata( $post_id );965	$backup_sizes = get_post_meta( $post->ID, '_wp_attachment_backup_sizes', true );966 967	if ( ! is_array( $meta ) ) {968		$return->error = esc_js( __( 'Image data does not exist. Please re-upload the image.' ) );969		return $return;970	}971 972	if ( ! is_array( $backup_sizes ) ) {973		$backup_sizes = array();974	}975 976	// Generate new filename.977	$path = get_attached_file( $post_id );978 979	$basename = pathinfo( $path, PATHINFO_BASENAME );980	$dirname  = pathinfo( $path, PATHINFO_DIRNAME );981	$ext      = pathinfo( $path, PATHINFO_EXTENSION );982	$filename = pathinfo( $path, PATHINFO_FILENAME );983	$suffix   = time() . rand( 100, 999 );

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 6.7.7 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.