PHPXRef 0.7.1 : WordPress Trunk (Updated Daily) : Detail view of class-wp-image-editor-gd.php

Class: WP_Image_Editor_GD - X-Ref

WordPress Image Editor Class for Image Manipulation through GD

__destruct() X-Ref

GD Resource.

test( $args = array() X-Ref

Checks to see if current environment supports GD.

param: array $args
return: bool

supports_mime_type( $mime_type ) X-Ref

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

param: string $mime_type
return: bool

load() X-Ref

Loads image from $this->file into new GD Resource.

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

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

No description

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

Resizes current image.

Wraps `::_resize()` which returns a GD resource or GdImage instance.

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|array $crop  {
return: true|WP_Error

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

param: int        $max_w
param: int        $max_h
param: bool|array $crop  {
return: resource|GdImage|WP_Error

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.

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,

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

rotate( $angle ) X-Ref

Rotates current image counter-clockwise by $angle.
Ported from image-edit.php

param: float $angle
return: true|WP_Error

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

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

Saves current in-memory image to file.

param: string|null $destfilename Optional. Destination filename. Default null.
param: string|null $mime_type Optional. The mime-type. Default null.
return: array|WP_Error {

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

param: resource|GdImage $image
param: string|null $filename
param: string|null $mime_type
return: array|WP_Error {

set_quality( $quality = null ) X-Ref

Sets Image Compression quality on a 1-100% scale. Handles WebP lossless images.

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

stream( $mime_type = null ) X-Ref

Returns stream of current image.

param: string $mime_type The mime type of the image.
return: bool True on success, false on failure.

make_image( $filename, $callback, $arguments ) X-Ref

Either calls editor's save function or handles file as a stream.

param: string $filename
param: callable $callback
param: array $arguments
return: bool

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

PHP Cross Reference of WordPress Trunk (Updated Daily)

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

Defines 1 class