PHPXRef 0.7.1 : WordPress : Detail view of class-wp-image-editor-imagick.php

Class: WP_Image_Editor_Imagick - X-Ref

WordPress Image Editor Class for Image Manipulation through Imagick PHP Module

Imagick object.

Checks to see if current environment supports Imagick.

We require Imagick 2.2.0 or greater, based on whether the queryFormats()
method can be called statically.

param: array $args
return: bool
since: 3.5.0

supports_mime_type( $mime_type ) X-Ref

Checks to see if editor supports the mime-type specified.

param: string $mime_type
return: bool
since: 3.5.0

load() X-Ref

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

return: true|WP_Error True if loaded; WP_Error on failure.
since: 3.5.0

set_quality( $quality = null ) X-Ref

Sets Image Compression quality on a 1-100% scale.

param: int $quality Compression Quality. Range: [1,100]
return: true|WP_Error True if set successfully; WP_Error on failure.
since: 3.5.0

update_size( $width = null, $height = null ) X-Ref

Sets or updates current image size.

param: int $width
param: int $height
return: true|WP_Error
since: 3.5.0

resize( $max_w, $max_h, $crop = false ) X-Ref

Resizes current image.

At minimum, either a height or width must be provided.
If one of the two is set to null, the resize will
maintain aspect ratio according to the provided dimension.

param: int|null $max_w Image width.
param: int|null $max_h Image height.
param: bool $crop
return: true|WP_Error
since: 3.5.0

thumbnail_image( $dst_w, $dst_h, $filter_name = 'FILTER_TRIANGLE', $strip_meta = true ) X-Ref

Efficiently resize the current image

This is a WordPress specific implementation of Imagick::thumbnailImage(),
which resizes an image to given dimensions and removes any associated profiles.

param: int    $dst_w       The destination width.
param: int    $dst_h       The destination height.
param: string $filter_name Optional. The Imagick filter to use when resizing. Default 'FILTER_TRIANGLE'.
param: bool   $strip_meta  Optional. Strip all profiles, excluding color profiles, from the image. Default true.
return: void|WP_Error
since: 4.5.0

multi_resize( $sizes ) X-Ref

Create multiple smaller images from a single source.

Attempts to create all sub-sizes and returns the meta data at the end. This
may result in the server running out of resources. When it fails there may be few
"orphaned" images left over as the meta data is never returned and saved.

As of 5.3.0 the preferred way to do this is with `make_subsize()`. It creates
the new images one at a time and allows for the meta data to be saved after
each new image is created.

param: array $sizes {
return: array An array of resized images' metadata by size.
since: 3.5.0

make_subsize( $size_data ) X-Ref

Create an image sub-size and return the image meta data value for it.

param: array $size_data {
return: array|WP_Error The image data array for inclusion in the `sizes` array in the image meta,
since: 5.3.0

crop( $src_x, $src_y, $src_w, $src_h, $dst_w = null, $dst_h = null, $src_abs = false ) X-Ref

Crops Image.

param: int  $src_x   The start x position to crop from.
param: int  $src_y   The start y position to crop from.
param: int  $src_w   The width to crop.
param: int  $src_h   The height to crop.
param: int  $dst_w   Optional. The destination width.
param: int  $dst_h   Optional. The destination height.
param: bool $src_abs Optional. If the source crop points are absolute.
return: true|WP_Error
since: 3.5.0

rotate( $angle ) X-Ref

Rotates current image counter-clockwise by $angle.

param: float $angle
return: true|WP_Error
since: 3.5.0

flip( $horz, $vert ) X-Ref

Flips current image.

param: bool $horz Flip along Horizontal Axis
param: bool $vert Flip along Vertical Axis
return: true|WP_Error
since: 3.5.0

maybe_exif_rotate() X-Ref

Check if a JPEG image has EXIF Orientation tag and rotate it if needed.

As ImageMagick copies the EXIF data to the flipped/rotated image, proceed only
if EXIF Orientation can be reset afterwards.

return: bool|WP_Error True if the image was rotated. False if no EXIF data or if the image doesn't need rotation.
since: 5.3.0

save( $destfilename = null, $mime_type = null ) X-Ref

Saves current image to file.

param: string $destfilename Optional. Destination filename. Default null.
param: string $mime_type Optional. The mime-type. Default null.
return: array|WP_Error {'path'=>string, 'file'=>string, 'width'=>int, 'height'=>int, 'mime-type'=>string}
since: 3.5.0

_save( $image, $filename = null, $mime_type = null ) X-Ref

param: Imagick $image
param: string $filename
param: string $mime_type
return: array|WP_Error

write_image( $image, $filename ) X-Ref

Writes an image to a file or stream.

param: Imagick $image
param: string $filename The destination filename or stream URL.
return: true|WP_Error
since: 5.6.0

stream( $mime_type = null ) X-Ref

Streams current image to browser.

param: string $mime_type The mime type of the image.
return: true|WP_Error True on success, WP_Error object on failure.
since: 3.5.0

strip_meta() X-Ref

Strips all image meta except color profiles from an image.

return: true|WP_Error True if stripping metadata was successful. WP_Error object on error.
since: 4.5.0

pdf_setup() X-Ref

Sets up Imagick for PDF processing.
Increases rendering DPI and only loads first page.

return: string|WP_Error File to load or WP_Error on failure.
since: 4.7.0

pdf_load_source() X-Ref

Load the image produced by Ghostscript.

Includes a workaround for a bug in Ghostscript 8.70 that prevents processing of some PDF files
when `use-cropbox` is set.

return: true|WP_Error
since: 5.6.0

File Size:	932 lines (27 kb)
Included or required:	1 time
Referenced:	0 times
Includes or requires:	0 files

PHP Cross Reference of WordPress

/wp-includes/ -> class-wp-image-editor-imagick.php (summary)

Defines 1 class