WP_Image_Editor_Imagick::load(): true|WP_Error

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Return value

true|WP_Error

True if loaded; WP_Error on failure.

Performance profile

How much work a call to WP_Image_Editor_Imagick::load() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reads or writes the filesystem via file_get_contents().

Scaling

Scales with input

The body loops, so the work grows with how much data it finds.

Instructions

46–183

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 319.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• filesystemfilesystem accessfile_get_contents()called directly
• hookthird-party callbacksapply_filters()one call below WP_Image_Editor_Imagick::load()

Further down the call graph this can also reach query, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 91 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Image_Editor_Imagick::load() can have, taken from its control-flow graph on PHP 8.5.

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Uses · 13

• wp_is_stream()Tests if a given path is a stream URL
• __()Retrieves the translation of $text.
• wp_parse_url()A wrapper for PHP's parse_url() function that handles consistency in the return values across PHP versions.
• wp_raise_memory_limit()Attempts to raise the PHP memory limit for memory intensive processes.
• str_starts_with()Polyfill for `str_starts_with()` function added in PHP 8.0.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• WP_Error::__construct()Initializes the error.
• Imagick::__construct()
• WP_Image_Editor_Imagick::pdf_load_source()Load the image produced by Ghostscript.
• WP_Image_Editor_Imagick::remove_pdf_alpha_channel()Removes PDF alpha after it's been read.
• WP_Image_Editor_Imagick::get_mime_type()
• WP_Image_Editor_Imagick::update_size()Sets or updates current image size.

Source code

View on Trac ↗View on GitHub ↗

150	public function load() {151		if ( $this->image instanceof Imagick ) {152			return true;153		}154 155		$is_stream = wp_is_stream( $this->file );156		$is_file   = ! $is_stream && is_file( $this->file );157 158		// Only allow loading files or streams.159		if ( ! $is_file && ! $is_stream ) {160			return new WP_Error( 'error_loading_image', __( 'File does not exist?' ), $this->file );161		}162 163		// Establish the provided filename based on the kind of resource being loaded.164		$given_filename = $this->file;165		if ( 0 === strncasecmp( $given_filename, 'file://', 7 ) ) {166			$given_filename = basename( substr( $given_filename, 7 ) ); // 7 is the strlen of 'file://'.167		} elseif ( 1 === preg_match( '~^https?://~i', $this->file ) ) {168			/*169			 * For URLs, it will be the final path segment.170			 *171			 * Example:172			 *173			 *     https://wordpress.org/i/happy.png?size=40px174			 *                             ╰───────╯175			 *                                this is the given filename176			 *177			 * If the stream returns a `Content-Disposition` header it would178			 * provide an alternative name, but this is used as a reasonable179			 * proxy to avoid adding the additional complexity of reading and180			 * parsing the returned HTTP headers.181			 */182			$url_path = wp_parse_url( $this->file, PHP_URL_PATH );183 184			// This URL can not be parsed, so it is not a valid image resource.185			if ( false === $url_path ) {186				return new WP_Error( 'error_loading_image', __( 'File is not an image.' ), $this->file );187			}188 189			/**190			 * The URL has an empty path, so continue with an empty string.191			 *192			 * This is the case with a URL such as `https://example.com?file_id=123`193			 */194			if ( null === $url_path ) {195				$url_path = '';196			}197 198			$last_path_at   = strrpos( $url_path, '/' );199			$given_filename = is_int( $last_path_at ) ? substr( $url_path, $last_path_at + 1 ) : $url_path;200			$given_filename = rawurldecode( $given_filename );201		}202 203		/*204		 * Strip off any potential `Imagick` format specifiers.205		 *206		 * If a real file exists with the identified format specifier, then207		 * `Imagick` may not treat it as a format, but WordPress will reject208		 * it anyway to avoid adding more complexity into this detection.209		 *210		 * `Imagick` reads only the first `FORMAT:` specifier on a name, but211		 * stripping a segment would promote a second specifier to the front212		 * of the name handed to `Imagick`, which would then honor it.213		 *214		 * Loop to capture all format specifiers for comparison.215		 *216		 * Exclude Windows drive-letter prefixes from here.217		 */218		$imagick_formats = array();219		while (220			false !== ( $format_ends_at = strpos( $given_filename, ':' ) ) &&221			1 !== preg_match( '~^[a-z]:~i', $given_filename )222		) {223			$imagick_formats[] = strtoupper( substr( $given_filename, 0, $format_ends_at ) );224			$given_filename    = substr( $given_filename, $format_ends_at + 1 );225		}226 227		$file_extension = strtolower( pathinfo( $given_filename, PATHINFO_EXTENSION ) );228 229		/*

Changelog

Introduced in 3.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.8.8 tag, from src/wp-includes/class-wp-image-editor-imagick.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.