wp_getimagesize( string $filename, array $image_info = null ): array|false

Compatibility

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

Parameters

$filenamestring

The file path.

$image_infoarrayoptional

Extended image information (passed by reference).Default: null

Return value

array|false

Array of image information or false on failure.

Performance profile

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

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

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

Instructions

18–88

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

14

14 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_getimagesize()

Further down the call graph this can also reach cache, query, option, 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 · 17 distinct outcomes

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

Uses · 6

• wp_get_image_mime()Returns the real mime type of an image file.
• wp_get_webp_info()Extracts meta information about a WebP file: width, height, and type.
• wp_get_avif_info()Extracts meta information about an AVIF file: width, height, bit depth, and number of channels.
• wp_is_heic_image_mime_type()Checks if a mime type is for a HEIC/HEIF image.
• 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.

Used by · 14

• Custom_Image_Header::create_attachment_object()Creates an attachment 'object'.
• Custom_Image_Header::step_2()Displays second step of custom header image page.
• WP_Image_Editor_GD::load()Loads image from $this->file into new GD Resource.
• WP_Image_Editor_Imagick::update_size()Sets or updates current image size.
• WP_Site_Icon::create_attachment_object()Creates an attachment 'object'.
• file_is_displayable_image()Validates that file is suitable for displaying within a web page.
• file_is_valid_image()Validates that file is an image.
• get_attachment_icon()Retrieve HTML content of icon attachment image element.
• image_downsize()Scales an image to fit a particular size (such as 'thumb' or 'medium').
• wp_copy_parent_attachment_properties()Copy parent attachment properties to newly cropped image.
• wp_create_image_subsizes()Creates image sub-sizes, adds the new data to the image meta `sizes` array, and updates the image metadata.
• wp_get_attachment_image_src()Retrieves an image to represent an attachment.

Source code

View on Trac ↗View on GitHub ↗

5676function wp_getimagesize( $filename, ?array &$image_info = null ) {5677	// Don't silence errors when in debug mode, unless running unit tests.5678	if ( defined( 'WP_DEBUG' ) && WP_DEBUG && ! defined( 'WP_RUN_CORE_TESTS' ) ) {5679		if ( 2 === func_num_args() ) {5680			$info = getimagesize( $filename, $image_info );5681		} else {5682			$info = getimagesize( $filename );5683		}5684	} else {5685		/*5686		 * Silencing notice and warning is intentional.5687		 *5688		 * getimagesize() has a tendency to generate errors, such as5689		 * "corrupt JPEG data: 7191 extraneous bytes before marker",5690		 * even when it's able to provide image size information.5691		 *5692		 * See https://core.trac.wordpress.org/ticket/424805693		 */5694		if ( 2 === func_num_args() ) {5695			$info = @getimagesize( $filename, $image_info );5696		} else {5697			$info = @getimagesize( $filename );5698		}5699	}5700 5701	if (5702		! empty( $info ) &&5703		// Some PHP versions return 0x0 sizes from `getimagesize` for unrecognized image formats, including AVIFs.5704		! ( empty( $info[0] ) && empty( $info[1] ) )5705	) {5706		return $info;5707	}5708 5709	$image_mime_type = wp_get_image_mime( $filename );5710 5711	// Not an image?5712	if ( false === $image_mime_type ) {5713		return false;5714	}5715 5716	/*5717	 * For PHP versions that don't support WebP images,5718	 * extract the image size info from the file headers.5719	 */5720	if ( 'image/webp' === $image_mime_type ) {5721		$webp_info = wp_get_webp_info( $filename );5722		$width     = $webp_info['width'];5723		$height    = $webp_info['height'];5724 5725		// Mimic the native return format.5726		if ( $width && $height ) {5727			return array(5728				$width,5729				$height,5730				IMAGETYPE_WEBP,5731				sprintf(5732					'width="%d" height="%d"',5733					$width,5734					$height5735				),5736				'mime' => 'image/webp',5737			);5738		}5739	}5740 5741	// For PHP versions that don't support AVIF images, extract the image size info from the file headers.5742	if ( 'image/avif' === $image_mime_type ) {5743		$avif_info = wp_get_avif_info( $filename );5744 5745		$width  = $avif_info['width'];5746		$height = $avif_info['height'];5747 5748		// Mimic the native return format.5749		if ( $width && $height ) {5750			return array(5751				$width,5752				$height,5753				IMAGETYPE_AVIF,5754				sprintf(5755					'width="%d" height="%d"',

Changelog

Introduced in 5.7.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-includes/media.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.