wp_update_image_subsizes( int $attachment_id ): array|WP_Error
- Since
- 5.3.0
- Source
wp-admin/includes/image.php:159
Compatibility
- WordPress
- since 5.3.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$attachment_idint- The image attachment post ID.
Return value
array|WP_Error- The updated image meta data array or WP_Error object if both the image meta and the attached file are missing.
Performance profile
How much work a call to wp_update_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
- Scaling
- Constant
- Instructions
- 20–38
- Plugin surface
- 1 hook
- Called by
- 2
Reaches the database via get_post().
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 55.
Third-party callbacks on 'wp_generate_attachment_metadata' run inside this call, and their cost is not bounded by anything here.
2 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()called directly - querycontent query
get_post()one call below wp_update_image_subsizes()
Further down the call graph this can also reach option, 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 · 4 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_update_image_subsizes() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!empty($image_meta) && is_array($image_meta) && empty($missing_sizes) | 20 | wp_get_attachment_metadata(), wp_get_original_image_path(), wp_get_missing_image_subsizes() |
empty($image_file) | 21–23 | wp_get_attachment_metadata(), wp_get_original_image_path(), __() |
!empty($image_file) | 31–33 | wp_get_attachment_metadata(), wp_get_original_image_path(), wp_create_image_subsizes(), apply_filters(), wp_update_attachment_metadata() |
!empty($image_meta) && is_array($image_meta) && !empty($missing_sizes) | 38 | wp_get_attachment_metadata(), wp_get_original_image_path(), wp_get_missing_image_subsizes(), _wp_make_subsizes(), apply_filters(), wp_update_attachment_metadata() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 55 instructions, 20–38 executed per call, 4 branches. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Hooks and filters fired · 1
One hook fires while wp_update_image_subsizes() runs, in this order:
- apply_filters( wp_generate_attachment_metadata )filterline 185 (+26 into the body)
Filters the generated attachment meta data.
Uses · 9
- wp_get_attachment_metadata()Retrieves attachment metadata for attachment ID.
- wp_get_original_image_path()Retrieves the path to an uploaded image file.
- wp_create_image_subsizes()Creates image sub-sizes, adds the new data to the image meta `sizes` array, and updates the image metadata.
- __()Retrieves the translation of $text.
- 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.
- _wp_make_subsizes()Low-level function to create image sub-sizes.
- apply_filters()Calls the callback functions that have been added to a filter hook.
- wp_update_attachment_metadata()Updates metadata for an attachment.
- WP_Error::__construct()Initializes the error.
Used by · 2
- WP_REST_Attachments_Controller::post_process_item()Performs post-processing on an attachment.
- wp_ajax_media_create_image_subsizes()Handles creating missing image sub-sizes for just uploaded images via AJAX.
Source code
function wp_update_image_subsizes( $attachment_id ) { $image_meta = wp_get_attachment_metadata( $attachment_id ); $image_file = wp_get_original_image_path( $attachment_id ); if ( empty( $image_meta ) || ! is_array( $image_meta ) ) { /* * Previously failed upload? * If there is an uploaded file, make all sub-sizes and generate all of the attachment meta. */ if ( ! empty( $image_file ) ) { $image_meta = wp_create_image_subsizes( $image_file, $attachment_id ); } else { return new WP_Error( 'invalid_attachment', __( 'The attached file cannot be found.' ) ); } } else { $missing_sizes = wp_get_missing_image_subsizes( $attachment_id ); if ( empty( $missing_sizes ) ) { return $image_meta; } // This also updates the image meta. $image_meta = _wp_make_subsizes( $missing_sizes, $image_file, $image_meta, $attachment_id ); } /** This filter is documented in wp-admin/includes/image.php */ $image_meta = apply_filters( 'wp_generate_attachment_metadata', $image_meta, $attachment_id, 'update' ); // Save the updated metadata. wp_update_attachment_metadata( $attachment_id, $image_meta ); return $image_meta;}Changelog
Introduced in 5.3.0. Unchanged from 6.7.7 through 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-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.