WP_Image_Editor_Imagick::pdf_load_source(): true|WP_Error

Description

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

Performance profile

How much work a call to WP_Image_Editor_Imagick::pdf_load_source() 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

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

8–33

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksdo_action()one call below WP_Image_Editor_Imagick::pdf_load_source()

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 · 4 distinct outcomes

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

Uses · 4

• is_wp_error()Checks whether the given variable is a WordPress Error.
• __()Retrieves the translation of $text.
• WP_Image_Editor_Imagick::pdf_setup()Sets up Imagick for PDF processing.
• WP_Error::__construct()Initializes the error.

Used by · 1

• WP_Image_Editor_Imagick::load()Loads image from $this->file into new Imagick Object.

Source code

View on Trac ↗View on GitHub ↗

1355	protected function pdf_load_source() {1356		$filename = $this->pdf_setup();1357 1358		if ( is_wp_error( $filename ) ) {1359			return $filename;1360		}1361 1362		foreach ( array( 'true', 'false' ) as $use_cropbox ) {1363			try {1364				/**1365				 * When generating thumbnails from cropped PDF pages, Imagemagick uses the uncropped1366				 * area (resulting in unnecessary whitespace) unless the following option is set.1367				 *1368				 * However, it sometimes fails, so if that happens, run it without the option.1369				 *1370				 * @ticket 488531371				 */1372				$this->image->setOption( 'pdf:use-cropbox', $use_cropbox );1373 1374				/*1375				 * Reading image after Imagick instantiation because `setResolution`1376				 * only applies correctly before the image is read.1377				 */1378				if ( is_string( $this->stream_file_data ) ) {1379					$this->image->setFilename( 'PDF:unknown.pdf[0]' );1380					$this->image->readImageBlob( $this->stream_file_data, $this->image_given_name );1381				} else {1382					$this->image->readImage( $filename );1383				}1384 1385				return true;1386			} catch ( Exception $e ) {1387				continue;1388			}1389		}1390 1391		return new WP_Error( 'invalid_image', __( 'File is not an image.' ), $this->file );1392	}

Changelog

Introduced in 5.6.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 7.1.0 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.