[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

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

WordPress Imagick Image Editor

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

Defines 1 class

WP_Image_Editor_Imagick:: (19 methods):
  __destruct()
  test()
  supports_mime_type()
  load()
  set_quality()
  update_size()
  resize()
  thumbnail_image()
  multi_resize()
  make_subsize()
  crop()
  rotate()
  flip()
  maybe_exif_rotate()
  save()
  _save()
  stream()
  strip_meta()
  pdf_setup()


Class: WP_Image_Editor_Imagick  - X-Ref

WordPress Image Editor Class for Image Manipulation through Imagick PHP Module

__destruct()   X-Ref
Imagick object.


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.

since: 3.5.0
return: bool
param: array $args

supports_mime_type( $mime_type )   X-Ref
Checks to see if editor supports the mime-type specified.

since: 3.5.0
return: bool
param: string $mime_type

load()   X-Ref
Loads image from $this->file into new Imagick Object.

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

set_quality( $quality = null )   X-Ref
Sets Image Compression quality on a 1-100% scale.

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

update_size( $width = null, $height = null )   X-Ref
Sets or updates current image size.

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

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.

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

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.

since: 4.5.0
return: bool|WP_Error
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.

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.

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

make_subsize( $size_data )   X-Ref
Create an image sub-size and return the image meta data value for it.

since: 5.3.0
return: WP_Error|array WP_Error on error, or the image data array for inclusion in the `sizes` array in the image meta.
param: array $size_data Array of width, height, and whether to crop.

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

since: 3.5.0
return: bool|WP_Error
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.

rotate( $angle )   X-Ref
Rotates current image counter-clockwise by $angle.

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

flip( $horz, $vert )   X-Ref
Flips current image.

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

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.

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

save( $destfilename = null, $mime_type = null )   X-Ref
Saves current image to file.

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

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

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

stream( $mime_type = null )   X-Ref
Streams current image to browser.

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

strip_meta()   X-Ref
Strips all image meta except color profiles from an image.

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

pdf_setup()   X-Ref
Sets up Imagick for PDF processing.
Increases rendering DPI and only loads first page.

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



Generated: Sun Sep 22 01:00:03 2019 Cross-referenced by PHPXref 0.7.1