WP_Image_Editor_GD::set_quality │ public │ WP 6.7.0

Sets Image Compression quality on a 1-100% scale. Handles WebP lossless images.

Method of the class: WP_Image_Editor_GD{}

No Hooks.

Returns

true|WP_Error. True if set successfully; WP_Error on failure.

Usage

$WP_Image_Editor_GD = new WP_Image_Editor_GD();
$WP_Image_Editor_GD->set_quality( $quality, $dims );

$quality(int)

Compression Quality. Range: [1,100].
Default: null

$dims(array)

Image dimensions array with 'width' and 'height' keys.
Default: array()

Changelog

WP_Image_Editor_GD::set_quality() WP Image Editor GD::set quality code ^{WP 6.9.1}

public function set_quality( $quality = null, $dims = array() ) {
	$quality_result = parent::set_quality( $quality, $dims );
	if ( is_wp_error( $quality_result ) ) {
		return $quality_result;
	} else {
		$quality = $this->get_quality();
	}

	// Handle setting the quality for WebP lossless images, see https://php.watch/versions/8.1/gd-webp-lossless.
	try {
		if ( 'image/webp' === $this->mime_type && defined( 'IMG_WEBP_LOSSLESS' ) ) {
			$webp_info = wp_get_webp_info( $this->file );
			if ( ! empty( $webp_info['type'] ) && 'lossless' === $webp_info['type'] ) {
				$quality = IMG_WEBP_LOSSLESS;
				parent::set_quality( $quality, $dims );
			}
		}
	} catch ( Exception $e ) {
		return new WP_Error( 'image_quality_error', $e->getMessage() );
	}
	$this->quality = $quality;
	return true;
}