wp_get_registered_image_subsizes(): array[]

Compatibility

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

Return value

array[]

Associative array of arrays of image sub-size information, keyed by image size name.

Performance profile

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

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling

Scales with input

The body loops, so the work grows with how much data it finds.

Instructions

9–10

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

9

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

What it touches

• optionoption read or writeget_option()called directly
• hookthird-party callbacksapply_filters()one call below wp_get_registered_image_subsizes()
• cacheobject cachewp_cache_get()one call below wp_get_registered_image_subsizes()
• serializeserialisationmaybe_unserialize()one call below wp_get_registered_image_subsizes()

Further down the call graph this can also reach query 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 · 1 distinct outcome

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

Uses · 3

• wp_get_additional_image_sizes()Retrieves additional image sizes.
• get_intermediate_image_sizes()Gets the available intermediate image size names.
• get_option()Retrieves an option value based on an option name.

Used by · 9

• WP_REST_Attachments_Controller::get_item_schema()Retrieves the attachment's schema, conforming to JSON Schema.
• WP_REST_Attachments_Controller::prepare_item_for_response()Prepares a single attachment output for response.
• WP_REST_Attachments_Controller::validate_image_dimensions()Validates that uploaded image dimensions are appropriate for the specified image size.
• WP_REST_Attachments_Controller::validate_image_size_names()Validates an image size name, or an array of names sharing a single file.
• WP_REST_Server::get_index()Retrieves the site index.
• get_default_block_editor_settings()Returns the default block editor settings.
• 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_get_missing_image_subsizes()Compare the existing image sub-sizes (as saved in the attachment meta) to the currently registered image sub-sizes, and return the difference.

Source code

View on Trac ↗View on GitHub ↗

930function wp_get_registered_image_subsizes(): array {931	$additional_sizes = wp_get_additional_image_sizes();932	$all_sizes        = array();933 934	foreach ( get_intermediate_image_sizes() as $size_name ) {935		$size_data = array(936			'width'  => 0,937			'height' => 0,938			'crop'   => false,939		);940 941		if ( isset( $additional_sizes[ $size_name ]['width'] ) ) {942			// For sizes added by plugins and themes.943			$size_data['width'] = (int) $additional_sizes[ $size_name ]['width'];944		} else {945			// For default sizes set in options.946			$size_data['width'] = (int) get_option( "{$size_name}_size_w" );947		}948 949		if ( isset( $additional_sizes[ $size_name ]['height'] ) ) {950			$size_data['height'] = (int) $additional_sizes[ $size_name ]['height'];951		} else {952			$size_data['height'] = (int) get_option( "{$size_name}_size_h" );953		}954 955		if ( empty( $size_data['width'] ) && empty( $size_data['height'] ) ) {956			// This size isn't set.957			continue;958		}959 960		if ( isset( $additional_sizes[ $size_name ]['crop'] ) ) {961			$size_data['crop'] = $additional_sizes[ $size_name ]['crop'];962		} else {963			$size_data['crop'] = get_option( "{$size_name}_crop" );964		}965 966		if ( ! is_array( $size_data['crop'] ) || empty( $size_data['crop'] ) ) {967			$size_data['crop'] = (bool) $size_data['crop'];968		}969 970		$all_sizes[ $size_name ] = $size_data;971	}972 973	return $all_sizes;974}

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