WP_Image_Editor_GD::save( string|null $destfilename = null, string|null $mime_type = null )

Saves current in-memory image to file.

Parameters

$destfilename

(Optional) Destination filename.

Default value: null

$mime_type

(Optional) The mime-type.

Default value: null

Return

(array|WP_Error) Array on success or WP_Error if the file failed to save.<br>

  • 'path'
    (string) Path to the image file.<br>
  • 'file'
    (string) Name of the image file.<br>
  • 'width'
    (int) Image width.<br>
  • 'height'
    (int) Image height.<br>
  • 'mime-type'
    (string) The mime type of the image.<br>
  • 'filesize'
    (int) File size of the image.<br>

Source

File: wp-includes/class-wp-image-editor-gd.php 

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

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

		return $saved;
	}

Expand Source Code View on GitHub

Related

Changelog

Changelog
Version Description
6.0.0 The $filesize value was added to the returned array.
5.9.0 Renamed $filename to $destfilename to match parent class for PHP 8 named parameter support.
3.5.0 Introduced.