WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_Image_Editor_Imagick::save()

WP_Image_Editor_Imagick::save( string $destfilename = null, string $mime_type = null ): array|WP_Error

In this article

Back to top

Saves current image to file.

Parameters

$destfilenamestringoptional
Destination filename.

Default:null

$mime_typestringoptional
The mime-type.

Default:null

Return

array|WP_Error Array on success or WP_Error if the file failed to save.
  • path string
    Path to the image file.
  • file string
    Name of the image file.
  • width int
    Image width.
  • height int
    Image height.
  • mime-type string
    The mime type of the image.
  • filesize int
    File size of the image.

Source

public function save( $destfilename = null, $mime_type = null ) {
	$saved = $this->_save( $this->image, $destfilename, $mime_type );

	if ( ! is_wp_error( $saved ) ) {
		$this->file      = $saved['path'];
		$this->mime_type = $saved['mime-type'];

		try {
			$this->image->setImageFormat( strtoupper( $this->get_extension( $this->mime_type ) ) );
		} catch ( Exception $e ) {
			return new WP_Error( 'image_save_error', $e->getMessage(), $this->file );
		}
	}

	return $saved;
}

View all references View on Trac View on GitHub

UsesDescription
WP_Image_Editor_Imagick::_save()wp-includes/class-wp-image-editor-imagick.php
is_wp_error()wp-includes/load.php

Checks whether the given variable is a WordPress Error.

WP_Error::__construct()wp-includes/class-wp-error.php

Initializes the error.

Show 1 moreShow less

Changelog

VersionDescription
6.0.0The $filesize value was added to the returned array.
3.5.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.