Alert: This function’s access is marked private. This means it is not intended for use by plugin or theme developers, only in other core functions. It is listed here for completeness.

WP_Image_Editor_Imagick::write_image( Imagick $image, string $filename ): true|WP_Error

Writes an image to a file or stream.


Parameters

$image Imagick Required
$filename string Required
The destination filename or stream URL.

Top ↑

Return

true|WP_Error


Top ↑

Source

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

private function write_image( $image, $filename ) {
	if ( wp_is_stream( $filename ) ) {
		/*
		 * Due to reports of issues with streams with `Imagick::writeImageFile()` and `Imagick::writeImage()`, copies the blob instead.
		 * Checks for exact type due to: https://www.php.net/manual/en/function.file-put-contents.php
		 */
		if ( file_put_contents( $filename, $image->getImageBlob() ) === false ) {
			return new WP_Error(
				'image_save_error',
				sprintf(
					/* translators: %s: PHP function name. */
					__( '%s failed while writing image to stream.' ),
					'<code>file_put_contents()</code>'
				),
				$filename
			);
		} else {
			return true;
		}
	} else {
		$dirname = dirname( $filename );

		if ( ! wp_mkdir_p( $dirname ) ) {
			return new WP_Error(
				'image_save_error',
				sprintf(
					/* translators: %s: Directory path. */
					__( 'Unable to create directory %s. Is its parent directory writable by the server?' ),
					esc_html( $dirname )
				)
			);
		}

		try {
			return $image->writeImage( $filename );
		} catch ( Exception $e ) {
			return new WP_Error( 'image_save_error', $e->getMessage(), $filename );
		}
	}
}


Top ↑

Changelog

Changelog
Version Description
5.6.0 Introduced.

Top ↑

User Contributed Notes

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