WP_Image_Editor_Imagick::write_image( Imagick $image, string $filename ): true|WP_Error
- Since
- 5.6.0
- Source
wp-includes/class-wp-image-editor-imagick.php:1190
Compatibility
- WordPress
- since 5.6.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
$imageImagick$filenamestring- The destination filename or stream URL.
Return value
true|WP_Error
Performance profile
How much work a call to WP_Image_Editor_Imagick::write_image() 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
- 15–27
- Plugin surface
- None
- Called by
- 1
Reads or writes the filesystem via file_put_contents().
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 62.
Nothing here hands control to plugin code.
1 place in core call this, so the cost is paid more often than your own code shows.
What it touches
- filesystemfilesystem access
file_put_contents()called directly - hookthird-party callbacks
apply_filters()one call below WP_Image_Editor_Imagick::write_image()
Further down the call graph this can also reach option, cache, serialize, 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 · 4 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Image_Editor_Imagick::write_image() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
wp_is_stream() | 15 | wp_is_stream(), ->getImageBlob(), file_put_contents() |
!wp_is_stream() && wp_mkdir_p() | 16 | wp_is_stream(), wp_mkdir_p(), ->writeImage() |
!wp_is_stream() && !wp_mkdir_p() | 27 | wp_is_stream(), wp_mkdir_p(), __(), esc_html(), sprintf() |
wp_is_stream() | 27 | wp_is_stream(), ->getImageBlob(), file_put_contents(), __(), sprintf() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 62 | 15–27 | 3 | |
| 8.5 | 62 | 15–27 | 3 | |
| 8.4 | 62 | 15–27 | 3 | 2 fewer instructions than PHP 8.3 |
| 8.3 | 64 | 15–29 | 3 | |
| 8.2 | 64 | 15–29 | 3 | |
| 8.1 | 64 | 15–29 | 3 | |
| 7.4 | 64 | 15–29 | 3 |
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.
Uses · 5
- wp_is_stream()Tests if a given path is a stream URL
- __()Retrieves the translation of $text.
- wp_mkdir_p()Recursive directory creation based on full path.
- esc_html()Escaping for HTML blocks.
- WP_Error::__construct()Initializes the error.
Used by · 1
Source code
private function write_image( $image, $filename ) { if ( wp_is_stream( $filename ) ) { /* * Due to reports of issues with streams with `Imagick::writeImageFile()` and `Imagick::writeImage()`, copies the blob instead. * Checks for exact type due to: https://www.php.net/manual/en/function.file-put-contents.php */ if ( file_put_contents( $filename, $image->getImageBlob() ) === false ) { return new WP_Error( 'image_save_error', sprintf( /* translators: %s: PHP function name. */ __( '%s failed while writing image to stream.' ), '<code>file_put_contents()</code>' ), $filename ); } else { return true; } } else { $dirname = dirname( $filename ); if ( ! wp_mkdir_p( $dirname ) ) { return new WP_Error( 'image_save_error', sprintf( /* translators: %s: Directory path. */ __( 'Unable to create directory %s. Is its parent directory writable by the server?' ), esc_html( $dirname ) ) ); } try { return $image->writeImage( $filename ); } catch ( Exception $e ) { return new WP_Error( 'image_save_error', $e->getMessage(), $filename ); } } }Changelog
Introduced in 5.6.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 6.9.7 tag, from
src/wp-includes/class-wp-image-editor-imagick.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.