WP_Image_Editor_Imagick::_save( Imagick $image, string $filename = null, string $mime_type = null ): array|WP_Error

Compatibility

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

Parameters

$imageImagick

$filenamestringoptional

Default: null

$mime_typestringoptional

Default: null

Return value

array|WP_Error

Array on success or WP_Error if the file failed to save.

• $pathstring

  Path to the image file.

• $filestring

  Name of the image file.

• $widthint

  Image width.

• $heightint

  Image height.

• $mime-typestring

  The mime type of the image.

• $filesizeint

  File size of the image.

Performance profile

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

48–123

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

Plugin surface

2 hooks

Third-party callbacks on 'image_save_progressive', 'image_make_intermediate_size' run inside this call, and their cost is not bounded by anything here.

Called by

2

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

What it touches

• hookthird-party callbacksapply_filters()called directly

What one call costs · 24 distinct outcomes

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

Hooks and filters fired · 2

2 hooks fire while WP_Image_Editor_Imagick::_save() runs, in this order:

1. 1
   apply_filters( image_save_progressive )filterline 1041 (+23 into the body)

   Filters whether to output progressive images (if available).

2. 2
   apply_filters( image_make_intermediate_size )filterline 1072 (+54 into the body)

   Filters the name of the saved image file.

Uses · 9

• apply_filters()Calls the callback functions that have been added to a filter hook.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• wp_basename()i18n-friendly version of basename().
• wp_filesize()Wrapper for PHP filesize with filters and casting the result as an integer.
• WP_Image_Editor_Imagick::get_output_format()
• WP_Image_Editor_Imagick::generate_filename()
• WP_Image_Editor_Imagick::get_extension()
• WP_Error::__construct()Initializes the error.
• WP_Image_Editor_Imagick::write_image()Writes an image to a file or stream.

Used by · 2

• WP_Image_Editor_Imagick::make_subsize()Create an image sub-size and return the image meta data value for it.
• WP_Image_Editor_Imagick::save()Saves current image to file.

Source code

View on Trac ↗View on GitHub ↗

1018	protected function _save( $image, $filename = null, $mime_type = null ) {1019		list( $filename, $extension, $mime_type ) = $this->get_output_format( $filename, $mime_type );1020 1021		if ( ! $filename ) {1022			$filename = $this->generate_filename( null, null, $extension );1023		}1024 1025		try {1026			// Store initial format.1027			$orig_format = $this->image->getImageFormat();1028 1029			$this->image->setImageFormat( strtoupper( $this->get_extension( $mime_type ) ) );1030		} catch ( Exception $e ) {1031			return new WP_Error( 'image_save_error', $e->getMessage(), $filename );1032		}1033 1034		if ( method_exists( $this->image, 'setInterlaceScheme' )1035			&& method_exists( $this->image, 'getInterlaceScheme' )1036			&& defined( 'Imagick::INTERLACE_PLANE' )1037		) {1038			$orig_interlace = $this->image->getInterlaceScheme();1039 1040			/** This filter is documented in wp-includes/class-wp-image-editor-gd.php */1041			if ( apply_filters( 'image_save_progressive', false, $mime_type ) ) {1042				$this->image->setInterlaceScheme( Imagick::INTERLACE_PLANE ); // True - line interlace output.1043			} else {1044				$this->image->setInterlaceScheme( Imagick::INTERLACE_NO ); // False - no interlace output.1045			}1046		}1047 1048		$write_image_result = $this->write_image( $this->image, $filename );1049		if ( is_wp_error( $write_image_result ) ) {1050			return $write_image_result;1051		}1052 1053		try {1054			// Reset original format.1055			$this->image->setImageFormat( $orig_format );1056 1057			if ( isset( $orig_interlace ) ) {1058				$this->image->setInterlaceScheme( $orig_interlace );1059			}1060		} catch ( Exception $e ) {1061			return new WP_Error( 'image_save_error', $e->getMessage(), $filename );1062		}1063 1064		// Set correct file permissions.1065		$stat  = stat( dirname( $filename ) );1066		$perms = $stat['mode'] & 0000666; // Same permissions as parent folder, strip off the executable bits.1067		chmod( $filename, $perms );1068 1069		return array(1070			'path'      => $filename,1071			/** This filter is documented in wp-includes/class-wp-image-editor-gd.php */1072			'file'      => wp_basename( apply_filters( 'image_make_intermediate_size', $filename ) ),1073			'width'     => $this->size['width'],1074			'height'    => $this->size['height'],1075			'mime-type' => $mime_type,1076			'filesize'  => wp_filesize( $filename ),1077		);1078	}

Changelog

Introduced in 3.5.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/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.