W3cubDocs

/WordPress

WP_Image_Editor_Imagick::load()

Loads image from $this->file into new Imagick Object.

Return

(true|WP_Error) True if loaded; WP_Error on failure.

Source

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

public function load() {
		if ( $this->image instanceof Imagick ) {
			return true;
		}

		if ( ! is_file( $this->file ) && ! preg_match( '|^https?://|', $this->file ) ) {
			return new WP_Error( 'error_loading_image', __( 'File doesn’t exist?' ), $this->file );
		}

		/*
		 * Even though Imagick uses less PHP memory than GD, set higher limit
		 * for users that have low PHP.ini limits.
		 */
		wp_raise_memory_limit( 'image' );

		try {
			$this->image    = new Imagick();
			$file_extension = strtolower( pathinfo( $this->file, PATHINFO_EXTENSION ) );
			$filename       = $this->file;

			if ( 'pdf' === $file_extension ) {
				$filename = $this->pdf_setup();
			}

			// Reading image after Imagick instantiation because `setResolution`
			// only applies correctly before the image is read.
			$this->image->readImage( $filename );

			if ( ! $this->image->valid() ) {
				return new WP_Error( 'invalid_image', __( 'File is not an image.' ), $this->file );
			}

			// Select the first frame to handle animated images properly.
			if ( is_callable( array( $this->image, 'setIteratorIndex' ) ) ) {
				$this->image->setIteratorIndex( 0 );
			}

			$this->mime_type = $this->get_mime_type( $this->image->getImageFormat() );
		} catch ( Exception $e ) {
			return new WP_Error( 'invalid_image', $e->getMessage(), $this->file );
		}

		$updated_size = $this->update_size();
		if ( is_wp_error( $updated_size ) ) {
			return $updated_size;
		}

		return $this->set_quality();
	}

Uses

Uses Description
wp-includes/class-wp-image-editor-imagick.php: WP_Image_Editor_Imagick::pdf_setup()

Sets up Imagick for PDF processing.
wp-includes/functions.php: wp_raise_memory_limit()

Attempts to raise the PHP memory limit for memory intensive processes.
wp-includes/l10n.php: __()

Retrieve the translation of $text.
wp-includes/class-wp-image-editor-imagick.php: WP_Image_Editor_Imagick::update_size()

Sets or updates current image size.
wp-includes/class-wp-image-editor-imagick.php: WP_Image_Editor_Imagick::set_quality()

Sets Image Compression quality on a 1-100% scale.
wp-includes/load.php: is_wp_error()

Check whether variable is a WordPress Error.
wp-includes/class-wp-error.php: WP_Error::__construct()

Initialize the error.

Changelog

Version Description
3.5.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_image_editor_imagick/load