WP_REST_Attachments_Controller::validate_image_dimensions( int $width, int $height, string $image_size, int $attachment_id ): true|WP_Error

Compatibility

Present in 1 of the 5 tracked releases, added in 7.1.0, and compiles on PHP 7.4 through 8.6-dev.

Parameters

$widthint

Uploaded image width.

$heightint

Uploaded image height.

$image_sizestring

The target image size name.

$attachment_idint

The attachment ID.

Return value

true|WP_Error

True if valid, WP_Error if invalid.

Performance profile

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

13–52

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

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_REST_Attachments_Controller::validate_image_dimensions()
• hookthird-party callbacksapply_filters()one call below WP_REST_Attachments_Controller::validate_image_dimensions()
• optionoption read or writeget_option()one call below WP_REST_Attachments_Controller::validate_image_dimensions()

Further down the call graph this can also reach cache, serialize 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_REST_Attachments_Controller::validate_image_dimensions() can have, taken from its control-flow graph on PHP 8.5.

Uses · 5

• __()Retrieves the translation of $text.
• wp_get_attachment_metadata()Retrieves attachment metadata for attachment ID.
• wp_get_registered_image_subsizes()Returns a normalized list of all currently registered image sub-sizes.
• WP_Error::__construct()Initializes the error.
• WP_REST_Attachments_Controller::dimension_exceeds_max()Checks whether a dimension exceeds the maximum allowed value.

Used by · 1

• WP_REST_Attachments_Controller::sideload_item()Side-loads a media file without creating a new attachment.

Source code

View on Trac ↗View on GitHub ↗

2620	private function validate_image_dimensions( int $width, int $height, string $image_size, int $attachment_id ) {2621		// All image sizes require positive dimensions.2622		if ( $width <= 0 || $height <= 0 ) {2623			return new WP_Error(2624				'rest_upload_invalid_dimensions',2625				__( 'Uploaded image must have positive dimensions.' ),2626				array( 'status' => 400 )2627			);2628		}2629 2630		/*2631		 * 'original' size: the full-size image that replaces the main file (see2632		 * sideload_item()/finalize_item()). The endpoint expects any EXIF2633		 * orientation to be applied to the image already, which can swap width2634		 * and height, so the dimensions must match the stored dimensions or be2635		 * their transpose.2636		 */2637		if ( 'original' === $image_size ) {2638			$metadata = wp_get_attachment_metadata( $attachment_id, true );2639			if ( is_array( $metadata ) && isset( $metadata['width'], $metadata['height'] ) ) {2640				$expected_width  = (int) $metadata['width'];2641				$expected_height = (int) $metadata['height'];2642 2643				$matches_dimensions    = $width === $expected_width && $height === $expected_height;2644				$transposes_dimensions = $width === $expected_height && $height === $expected_width;2645 2646				if ( ! $matches_dimensions && ! $transposes_dimensions ) {2647					return new WP_Error(2648						'rest_upload_dimension_mismatch',2649						sprintf(2650							/* translators: 1: Actual width, 2: actual height, 3: expected width, 4: expected height. */2651							__( 'Uploaded image dimensions (%1$dx%2$d) do not match original image dimensions (%3$dx%4$d).' ),2652							$width,2653							$height,2654							$expected_width,2655							$expected_height2656						),2657						array( 'status' => 400 )2658					);2659				}2660			}2661			return true;2662		}2663 2664		// 'full' size (PDF thumbnails) and 'scaled': no further constraints.2665		if ( in_array( $image_size, array( 'full', 'scaled' ), true ) ) {2666			return true;2667		}2668 2669		/*2670		 * 'animated_video_poster' companion: a static poster image for the2671		 * converted video. It is a real image (so it has positive dimensions)2672		 * but is not a registered sub-size, so it has no dimension constraint.2673		 */2674		if ( 'animated_video_poster' === $image_size ) {2675			return true;2676		}2677 2678		// Regular image sizes: validate against registered size constraints.2679		$registered_sizes = wp_get_registered_image_subsizes();2680 2681		if ( ! isset( $registered_sizes[ $image_size ] ) ) {2682			return new WP_Error(2683				'rest_upload_unknown_size',2684				__( 'Unknown image size.' ),2685				array( 'status' => 400 )2686			);2687		}2688 2689		$size_data  = $registered_sizes[ $image_size ];2690		$max_width  = (int) $size_data['width'];2691		$max_height = (int) $size_data['height'];2692 2693		// Validate dimensions don't exceed the registered size maximums.2694		// Allow 1px tolerance for rounding differences.2695		$tolerance = 1;2696 2697		if ( $this->dimension_exceeds_max( $width, $max_width, $tolerance ) ) {2698			return new WP_Error(2699				'rest_upload_dimension_mismatch',

Changelog

Introduced in 7.1.0.

Signature, return type and hooks compared across 1 parsed release.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.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.