WP_Image_Editor_GD::stream( string $mime_type = null ): bool

In this article

Returns stream of current image.

Parameters

$mime_typestringoptional
The mime type of the image.

Default:null

Return

bool True on success, false on failure.

Source

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

	switch ( $mime_type ) {
		case 'image/png':
			header( 'Content-Type: image/png' );
			return imagepng( $this->image );
		case 'image/gif':
			header( 'Content-Type: image/gif' );
			return imagegif( $this->image );
		case 'image/webp':
			if ( function_exists( 'imagewebp' ) ) {
				header( 'Content-Type: image/webp' );
				return imagewebp( $this->image, null, $this->get_quality() );
			} else {
				// Fall back to JPEG.
				header( 'Content-Type: image/jpeg' );
				return imagejpeg( $this->image, null, $this->get_quality() );
			}
		case 'image/avif':
			if ( function_exists( 'imageavif' ) ) {
				header( 'Content-Type: image/avif' );
				return imageavif( $this->image, null, $this->get_quality() );
			}
			// Fall back to JPEG.
		default:
			header( 'Content-Type: image/jpeg' );
			return imagejpeg( $this->image, null, $this->get_quality() );
	}
}

Changelog

VersionDescription
3.5.0Introduced.

User Contributed Notes

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