: str_replace(): Passing null to parameter #2 ($replace) of type array|string is deprecated in
* WordPress Imagick Image Editor
* @subpackage Image_Editor
* WordPress Image Editor Class for Image Manipulation through Imagick PHP Module
class WP_Image_Editor_Imagick extends WP_Image_Editor {
public function __destruct() {
if ( $this->image instanceof Imagick ) {
// We don't need the original in memory anymore.
* Checks to see if current environment supports Imagick.
* We require Imagick 2.2.0 or greater, based on whether the queryFormats()
* method can be called statically.
public static function test( $args = array() ) {
// First, test Imagick's extension and classes.
if ( ! extension_loaded( 'imagick' ) || ! class_exists( 'Imagick', false ) || ! class_exists( 'ImagickPixel', false ) ) {
if ( version_compare( phpversion( 'imagick' ), '2.2.0', '<' ) ) {
$required_methods = array(
'setimagecompressionquality',
// Now, test for deep requirements within Imagick.
if ( ! defined( 'imagick::COMPRESSION_JPEG' ) ) {
$class_methods = array_map( 'strtolower', get_class_methods( 'Imagick' ) );
if ( array_diff( $required_methods, $class_methods ) ) {
* Checks to see if editor supports the mime-type specified.
* @param string $mime_type
public static function supports_mime_type( $mime_type ) {
$imagick_extension = strtoupper( self::get_extension( $mime_type ) );
if ( ! $imagick_extension ) {
* setIteratorIndex is optional unless mime is an animated format.
* Here, we just say no if you are missing it and aren't loading a jpeg.
if ( ! method_exists( 'Imagick', 'setIteratorIndex' ) && 'image/jpeg' !== $mime_type ) {
// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
return ( (bool) @Imagick::queryFormats( $imagick_extension ) );
} catch ( Exception $e ) {
* Loads image from $this->file into new Imagick Object.
* @return true|WP_Error True if loaded; WP_Error on failure.
if ( $this->image instanceof Imagick ) {
if ( ! is_file( $this->file ) && ! wp_is_stream( $this->file ) ) {
return new WP_Error( 'error_loading_image', __( 'File does not exist?' ), $this->file );
* Even though Imagick uses less PHP memory than GD, set higher limit
* for users that have low PHP.ini limits.
wp_raise_memory_limit( 'image' );
$this->image = new Imagick();
$file_extension = strtolower( pathinfo( $this->file, PATHINFO_EXTENSION ) );
if ( 'pdf' === $file_extension ) {
$pdf_loaded = $this->pdf_load_source();
if ( is_wp_error( $pdf_loaded ) ) {
if ( wp_is_stream( $this->file ) ) {
// Due to reports of issues with streams with `Imagick::readImageFile()`, uses `Imagick::readImageBlob()` instead.
$this->image->readImageBlob( file_get_contents( $this->file ), $this->file );
$this->image->readImage( $this->file );
if ( ! $this->image->valid() ) {
return new WP_Error( 'invalid_image', __( 'File is not an image.' ), $this->file );
// Select the first frame to handle animated images properly.
if ( is_callable( array( $this->image, 'setIteratorIndex' ) ) ) {
$this->image->setIteratorIndex( 0 );
if ( 'pdf' === $file_extension ) {
$this->remove_pdf_alpha_channel();
$this->mime_type = $this->get_mime_type( $this->image->getImageFormat() );
} catch ( Exception $e ) {
return new WP_Error( 'invalid_image', $e->getMessage(), $this->file );
$updated_size = $this->update_size();
if ( is_wp_error( $updated_size ) ) {
return $this->set_quality();
* Sets Image Compression quality on a 1-100% scale.
* @param int $quality Compression Quality. Range: [1,100]
* @return true|WP_Error True if set successfully; WP_Error on failure.
public function set_quality( $quality = null ) {
$quality_result = parent::set_quality( $quality );
if ( is_wp_error( $quality_result ) ) {
$quality = $this->get_quality();
switch ( $this->mime_type ) {
$this->image->setImageCompressionQuality( $quality );
$this->image->setImageCompression( imagick::COMPRESSION_JPEG );
$webp_info = wp_get_webp_info( $this->file );
if ( 'lossless' === $webp_info['type'] ) {
// Use WebP lossless settings.
$this->image->setImageCompressionQuality( 100 );
$this->image->setOption( 'webp:lossless', 'true' );
$this->image->setImageCompressionQuality( $quality );
$this->image->setImageCompressionQuality( $quality );
} catch ( Exception $e ) {
return new WP_Error( 'image_quality_error', $e->getMessage() );
* Sets or updates current image size.
protected function update_size( $width = null, $height = null ) {
if ( ! $width || ! $height ) {
$size = $this->image->getImageGeometry();
} catch ( Exception $e ) {
return new WP_Error( 'invalid_image', __( 'Could not read image size.' ), $this->file );
$height = $size['height'];
* If we still don't have the image size, fall back to `wp_getimagesize`. This ensures AVIF images
* are properly sized without affecting previous `getImageGeometry` behavior.
if ( ( ! $width || ! $height ) && 'image/avif' === $this->mime_type ) {
$size = wp_getimagesize( $this->file );
return parent::update_size( $width, $height );
* Sets Imagick time limit.
* Depending on configuration, Imagick processing may take time.
* Multiple problems exist if PHP times out before ImageMagick completed:
* 1. Temporary files aren't cleaned by ImageMagick garbage collection.
* 2. No clear error is provided.
* 3. The cause of such timeout can be hard to pinpoint.
* This function, which is expected to be run before heavy image routines, resolves
* point 1 above by aligning Imagick's timeout with PHP's timeout, assuming it is set.
* However seems it introduces more problems than it fixes,
* see https://core.trac.wordpress.org/ticket/58202.
* - Imagick resource exhaustion does not issue catchable exceptions (yet).
* See https://github.com/Imagick/imagick/issues/333.
* - The resource limit is not saved/restored. It applies to subsequent
* image operations within the time of the HTTP request.
* @since 6.3.0 This method was deprecated.
* @return int|null The new limit on success, null on failure.
public static function set_imagick_time_limit() {
_deprecated_function( __METHOD__, '6.3.0' );
if ( ! defined( 'Imagick::RESOURCETYPE_TIME' ) ) {
// Returns PHP_FLOAT_MAX if unset.
$imagick_timeout = Imagick::getResourceLimit( Imagick::RESOURCETYPE_TIME );
// Convert to an integer, keeping in mind that: 0 === (int) PHP_FLOAT_MAX.
$imagick_timeout = $imagick_timeout > PHP_INT_MAX ? PHP_INT_MAX : (int) $imagick_timeout;
$php_timeout = (int) ini_get( 'max_execution_time' );
if ( $php_timeout > 1 && $php_timeout < $imagick_timeout ) {
$limit = (float) 0.8 * $php_timeout;
Imagick::setResourceLimit( Imagick::RESOURCETYPE_TIME, $limit );
* At minimum, either a height or width must be provided.
* If one of the two is set to null, the resize will
* maintain aspect ratio according to the provided dimension.
* @param int|null $max_w Image width.
* @param int|null $max_h Image height.
* @param bool|array $crop {
* Optional. Image cropping behavior. If false, the image will be scaled (default).
* If true, image will be cropped to the specified dimensions using center positions.
* If an array, the image will be cropped using the array to specify the crop location:
* @type string $0 The x crop position. Accepts 'left' 'center', or 'right'.
* @type string $1 The y crop position. Accepts 'top', 'center', or 'bottom'.
public function resize( $max_w, $max_h, $crop = false ) {
if ( ( $this->size['width'] === $max_w ) && ( $this->size['height'] === $max_h ) ) {
$dims = image_resize_dimensions( $this->size['width'], $this->size['height'], $max_w, $max_h, $crop );
return new WP_Error( 'error_getting_dimensions', __( 'Could not calculate resized image dimensions' ) );
list( $dst_x, $dst_y, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h ) = $dims;
return $this->crop( $src_x, $src_y, $src_w, $src_h, $dst_w, $dst_h );
$thumb_result = $this->thumbnail_image( $dst_w, $dst_h );
if ( is_wp_error( $thumb_result ) ) {
return $this->update_size( $dst_w, $dst_h );
* Efficiently resize the current image
* This is a WordPress specific implementation of Imagick::thumbnailImage(),
* which resizes an image to given dimensions and removes any associated profiles.
* @param int $dst_w The destination width.
* @param int $dst_h The destination height.
* @param string $filter_name Optional. The Imagick filter to use when resizing. Default 'FILTER_TRIANGLE'.
* @param bool $strip_meta Optional. Strip all profiles, excluding color profiles, from the image. Default true.
protected function thumbnail_image( $dst_w, $dst_h, $filter_name = 'FILTER_TRIANGLE', $strip_meta = true ) {
$allowed_filters = array(
* Set the filter value if '$filter_name' name is in the allowed list and the related
* Imagick constant is defined or fall back to the default filter.
if ( in_array( $filter_name, $allowed_filters, true ) && defined( 'Imagick::' . $filter_name ) ) {
$filter = constant( 'Imagick::' . $filter_name );
$filter = defined( 'Imagick::FILTER_TRIANGLE' ) ? Imagick::FILTER_TRIANGLE : false;
* Filters whether to strip metadata from images when they're resized.
* This filter only applies when resizing using the Imagick editor since GD
* always strips profiles by default.
* @param bool $strip_meta Whether to strip image metadata during resizing. Default true.
if ( apply_filters( 'image_strip_meta', $strip_meta ) ) {
$this->strip_meta(); // Fail silently if not supported.
* To be more efficient, resample large images to 5x the destination size before resizing
* whenever the output size is less that 1/3 of the original image size (1/3^2 ~= .111),
* unless we would be resampling to a scale smaller than 128x128.
if ( is_callable( array( $this->image, 'sampleImage' ) ) ) {
$resize_ratio = ( $dst_w / $this->size['width'] ) * ( $dst_h / $this->size['height'] );
if ( $resize_ratio < .111 && ( $dst_w * $sample_factor > 128 && $dst_h * $sample_factor > 128 ) ) {
$this->image->sampleImage( $dst_w * $sample_factor, $dst_h * $sample_factor );
* Use resizeImage() when it's available and a valid filter value is set.
* Otherwise, fall back to the scaleImage() method for resizing, which
* results in better image quality over resizeImage() with default filter
* settings and retains backward compatibility with pre 4.5 functionality.
if ( is_callable( array( $this->image, 'resizeImage' ) ) && $filter ) {
$this->image->setOption( 'filter:support', '2.0' );
$this->image->resizeImage( $dst_w, $dst_h, $filter, 1 );
$this->image->scaleImage( $dst_w, $dst_h );
// Set appropriate quality settings after resizing.
if ( 'image/jpeg' === $this->mime_type ) {
if ( is_callable( array( $this->image, 'unsharpMaskImage' ) ) ) {
$this->image->unsharpMaskImage( 0.25, 0.25, 8, 0.065 );
$this->image->setOption( 'jpeg:fancy-upsampling', 'off' );
if ( 'image/png' === $this->mime_type ) {
$this->image->setOption( 'png:compression-filter', '5' );
$this->image->setOption( 'png:compression-level', '9' );
$this->image->setOption( 'png:compression-strategy', '1' );
$this->image->setOption( 'png:exclude-chunk', 'all' );
* If alpha channel is not defined, set it opaque.
* Note that Imagick::getImageAlphaChannel() is only available if Imagick
* has been compiled against ImageMagick version 6.4.0 or newer.
if ( is_callable( array( $this->image, 'getImageAlphaChannel' ) )
&& is_callable( array( $this->image, 'setImageAlphaChannel' ) )
&& defined( 'Imagick::ALPHACHANNEL_UNDEFINED' )
&& defined( 'Imagick::ALPHACHANNEL_OPAQUE' )
if ( $this->image->getImageAlphaChannel() === Imagick::ALPHACHANNEL_UNDEFINED ) {
$this->image->setImageAlphaChannel( Imagick::ALPHACHANNEL_OPAQUE );
// Limit the bit depth of resized images to 8 bits per channel.
if ( is_callable( array( $this->image, 'getImageDepth' ) ) && is_callable( array( $this->image, 'setImageDepth' ) ) ) {
if ( 8 < $this->image->getImageDepth() ) {
$this->image->setImageDepth( 8 );
} catch ( Exception $e ) {
return new WP_Error( 'image_resize_error', $e->getMessage() );
* Create multiple smaller images from a single source.
* Attempts to create all sub-sizes and returns the meta data at the end. This