[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

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

WordPress GD Image Editor

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

Defines 1 class

WP_Image_Editor_GD:: (16 methods):
  __destruct()
  test()
  supports_mime_type()
  load()
  update_size()
  resize()
  _resize()
  multi_resize()
  make_subsize()
  crop()
  rotate()
  flip()
  save()
  _save()
  stream()
  make_image()


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.

return: bool
since: 3.5.0
param: array $args

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

return: bool
since: 3.5.0
param: string $mime_type

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

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

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

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

resize( $max_w, $max_h, $crop = false )   X-Ref
Resizes current image.
Wraps _resize, since _resize returns a GD Resource.

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.

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

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

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

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.

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

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

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

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

return: bool|WP_Error
since: 3.5.0
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.
Ported from image-edit.php

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

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

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

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

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

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

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

stream( $mime_type = null )   X-Ref
Returns stream of current image.

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

make_image( $filename, $function, $arguments )   X-Ref
Either calls editor's save function or handles file as a stream.

return: bool
since: 3.5.0
param: string|stream $filename
param: callable $function
param: array $arguments



Generated: Wed Nov 13 01:00:03 2019 Cross-referenced by PHPXref 0.7.1