WP_Image_Editor_Imagick::stream( string $mime_type = null ): true|WP_Error

Streams current image to browser.


Parameters

$mime_type string Optional
The mime type of the image.

Default: null


Top ↑

Return

true|WP_Error True on success, WP_Error object on failure.


Top ↑

Source

File: wp-includes/class-wp-image-editor-imagick.php. View all references

public function stream( $mime_type = null ) {
	list( $filename, $extension, $mime_type ) = $this->get_output_format( null, $mime_type );

	try {
		// Temporarily change format for stream.
		$this->image->setImageFormat( strtoupper( $extension ) );

		// Output stream of image content.
		header( "Content-Type: $mime_type" );
		print $this->image->getImageBlob();

		// Reset image to original format.
		$this->image->setImageFormat( $this->get_extension( $this->mime_type ) );
	} catch ( Exception $e ) {
		return new WP_Error( 'image_stream_error', $e->getMessage() );
	}

	return true;
}


Top ↑

Changelog

Changelog
Version Description
3.5.0 Introduced.

Top ↑

User Contributed Notes

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