WordPress Cross Reference

WordPress Imagick Image Editor

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

Defines 1 class

WP_Image_Editor_Imagick:: (14 methods):
  __destruct()
  test()
  supports_mime_type()
  load()
  set_quality()
  update_size()
  resize()
  multi_resize()
  crop()
  rotate()
  flip()
  save()
  _save()
  stream()

Class: WP_Image_Editor_Imagick - X-Ref

WordPress Image Editor Class for Image Manipulation through Imagick PHP Module

__destruct() X-Ref

No description

test( $args = array() X-Ref

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.

return: boolean

supports_mime_type( $mime_type ) X-Ref

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

param: string $mime_type
return: boolean

load() X-Ref

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

return: boolean|WP_Error True if loaded; WP_Error on failure.

set_quality( $quality = null ) X-Ref

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

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

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

Sets or updates current image size.

param: int $width
param: int $height

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

Resizes current image.

param: int $max_w
param: int $max_h
param: boolean $crop
return: boolean|WP_Error

multi_resize( $sizes ) X-Ref

Resize multiple images from a single source.

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

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

Crops Image.

param: string|int $src The source file or Attachment ID.
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: boolean $src_abs Optional. If the source crop points are absolute.
return: boolean|WP_Error

rotate( $angle ) X-Ref

Rotates current image counter-clockwise by $angle.

param: float $angle
return: boolean|WP_Error

flip( $horz, $vert ) X-Ref

Flips current image.

returns: boolean|WP_Error
param: boolean $horz Flip along Horizontal Axis
param: boolean $vert Flip along Vertical Axis

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

Saves current image to file.

param: string $destfilename
param: string $mime_type
return: array|WP_Error {'path'=>string, 'file'=>string, 'width'=>int, 'height'=>int, 'mime-type'=>string}

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

No description

stream( $mime_type = null ) X-Ref

Streams current image to browser.

param: string $mime_type
return: boolean|WP_Error

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

Defines 1 class