_wp_make_subsizes( array $new_sizes, string $file, array $image_meta, int $attachment_id ): array

Description

Compatibility

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

Parameters

$new_sizesarray

Array defining what sizes to create.

$filestring

Full path to the image file.

$image_metaarray

The attachment meta data array.

$attachment_idint

Attachment ID to process.

Return value

array

The attachment meta data with updated sizes array. Includes an array of errors encountered while resizing.

Performance profile

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

7–67

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

3

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

What it touches

• hookthird-party callbacksdo_action()one call below _wp_make_subsizes()
• querycontent queryget_post()one call below _wp_make_subsizes()

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

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

Uses · 3

• wp_get_image_editor()Returns a WP_Image_Editor instance and loads file into it.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• wp_update_attachment_metadata()Updates metadata for an attachment.

Used by · 3

• wp_create_image_subsizes()Creates image sub-sizes, adds the new data to the image meta `sizes` array, and updates the image metadata.
• wp_generate_attachment_metadata()Generates attachment meta data and create image sub-sizes for images.
• 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

View on Trac ↗View on GitHub ↗

430function _wp_make_subsizes( $new_sizes, $file, $image_meta, $attachment_id ) {431	if ( empty( $image_meta ) || ! is_array( $image_meta ) ) {432		// Not an image attachment.433		return array();434	}435 436	// Check if any of the new sizes already exist.437	if ( isset( $image_meta['sizes'] ) && is_array( $image_meta['sizes'] ) ) {438		foreach ( $image_meta['sizes'] as $size_name => $size_meta ) {439			/*440			 * Only checks "size name" so we don't override existing images even if the dimensions441			 * don't match the currently defined size with the same name.442			 * To change the behavior, unset changed/mismatched sizes in the `sizes` array in image meta.443			 */444			if ( array_key_exists( $size_name, $new_sizes ) ) {445				unset( $new_sizes[ $size_name ] );446			}447		}448	} else {449		$image_meta['sizes'] = array();450	}451 452	if ( empty( $new_sizes ) ) {453		// Nothing to do...454		return $image_meta;455	}456 457	/*458	 * Sort the image sub-sizes in order of priority when creating them.459	 * This ensures there is an appropriate sub-size the user can access immediately460	 * even when there was an error and not all sub-sizes were created.461	 */462	$priority = array(463		'medium'       => null,464		'large'        => null,465		'thumbnail'    => null,466		'medium_large' => null,467	);468 469	$new_sizes = array_filter( array_merge( $priority, $new_sizes ) );470 471	$editor = wp_get_image_editor( $file );472 473	if ( is_wp_error( $editor ) ) {474		// The image cannot be edited.475		return $image_meta;476	}477 478	// If stored EXIF data exists, rotate the source image before creating sub-sizes.479	if ( ! empty( $image_meta['image_meta'] ) ) {480		$rotated = $editor->maybe_exif_rotate();481 482		if ( is_wp_error( $rotated ) ) {483			// TODO: Log errors.484		}485	}486 487	if ( method_exists( $editor, 'make_subsize' ) ) {488		foreach ( $new_sizes as $new_size_name => $new_size_data ) {489			$new_size_meta = $editor->make_subsize( $new_size_data );490 491			if ( is_wp_error( $new_size_meta ) ) {492				// TODO: Log errors.493			} else {494				// Save the size meta value.495				$image_meta['sizes'][ $new_size_name ] = $new_size_meta;496				wp_update_attachment_metadata( $attachment_id, $image_meta );497			}498		}499	} else {500		// Fall back to `$editor->multi_resize()`.501		$created_sizes = $editor->multi_resize( $new_sizes );502 503		if ( ! empty( $created_sizes ) ) {504			$image_meta['sizes'] = array_merge( $image_meta['sizes'], $created_sizes );505			wp_update_attachment_metadata( $attachment_id, $image_meta );506		}507	}508 509	return $image_meta;

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