--- a/wp/wp-includes/class-wp-image-editor-gd.php Tue Jun 09 11:14:17 2015 +0000
+++ b/wp/wp-includes/class-wp-image-editor-gd.php Mon Oct 14 17:39:30 2019 +0200
@@ -10,15 +10,16 @@
* WordPress Image Editor Class for Image Manipulation through GD
*
* @since 3.5.0
- * @package WordPress
- * @subpackage Image_Editor
- * @uses WP_Image_Editor Extends class
+ *
+ * @see WP_Image_Editor
*/
class WP_Image_Editor_GD extends WP_Image_Editor {
/**
+ * GD Resource.
+ *
* @var resource
*/
- protected $image; // GD Resource
+ protected $image;
public function __destruct() {
if ( $this->image ) {
@@ -31,9 +32,11 @@
* Checks to see if current environment supports GD.
*
* @since 3.5.0
- * @access public
+ *
+ * @static
*
- * @return boolean
+ * @param array $args
+ * @return bool
*/
public static function test( $args = array() ) {
if ( ! extension_loaded('gd') || ! function_exists('gd_info') )
@@ -54,10 +57,11 @@
* Checks to see if editor supports the mime-type specified.
*
* @since 3.5.0
- * @access public
+ *
+ * @static
*
* @param string $mime_type
- * @return boolean
+ * @return bool
*/
public static function supports_mime_type( $mime_type ) {
$image_types = imagetypes();
@@ -77,9 +81,8 @@
* Loads image from $this->file into new GD Resource.
*
* @since 3.5.0
- * @access protected
*
- * @return boolean|WP_Error True if loaded successfully; WP_Error on failure.
+ * @return bool|WP_Error True if loaded successfully; WP_Error on failure.
*/
public function load() {
if ( $this->image )
@@ -88,16 +91,8 @@
if ( ! is_file( $this->file ) && ! preg_match( '|^https?://|', $this->file ) )
return new WP_Error( 'error_loading_image', __('File doesn’t exist?'), $this->file );
- /**
- * Filter the memory limit allocated for image manipulation.
- *
- * @since 3.5.0
- *
- * @param int|string $limit Maximum memory limit to allocate for images. Default WP_MAX_MEMORY_LIMIT.
- * Accepts an integer (bytes), or a shorthand string notation, such as '256M'.
- */
- // Set artificially high because GD uses uncompressed images in memory
- @ini_set( 'memory_limit', apply_filters( 'image_memory_limit', WP_MAX_MEMORY_LIMIT ) );
+ // Set artificially high because GD uses uncompressed images in memory.
+ wp_raise_memory_limit( 'image' );
$this->image = @imagecreatefromstring( file_get_contents( $this->file ) );
@@ -123,10 +118,10 @@
* Sets or updates current image size.
*
* @since 3.5.0
- * @access protected
*
* @param int $width
* @param int $height
+ * @return true
*/
protected function update_size( $width = false, $height = false ) {
if ( ! $width )
@@ -147,12 +142,11 @@
* maintain aspect ratio according to the provided dimension.
*
* @since 3.5.0
- * @access public
*
* @param int|null $max_w Image width.
* @param int|null $max_h Image height.
- * @param boolean $crop
- * @return boolean|WP_Error
+ * @param bool $crop
+ * @return true|WP_Error
*/
public function resize( $max_w, $max_h, $crop = false ) {
if ( ( $this->size['width'] == $max_w ) && ( $this->size['height'] == $max_h ) )
@@ -171,6 +165,13 @@
return new WP_Error( 'image_resize_error', __('Image resize failed.'), $this->file );
}
+ /**
+ *
+ * @param int $max_w
+ * @param int $max_h
+ * @param bool|array $crop
+ * @return resource|WP_Error
+ */
protected function _resize( $max_w, $max_h, $crop = false ) {
$dims = image_resize_dimensions( $this->size['width'], $this->size['height'], $max_w, $max_h, $crop );
if ( ! $dims ) {
@@ -193,19 +194,20 @@
* Resize multiple images from a single source.
*
* @since 3.5.0
- * @access public
*
* @param array $sizes {
- * An array of image size arrays. Default sizes are 'small', 'medium', 'large'.
+ * An array of image size arrays. Default sizes are 'small', 'medium', 'medium_large', 'large'.
*
* 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.
*
* @type array $size {
- * @type int ['width'] Optional. Image width.
- * @type int ['height'] Optional. Image height.
- * @type bool ['crop'] Optional. Whether to crop the image. Default false.
+ * Array of height, width values, and whether to crop.
+ *
+ * @type int $width Image width. Optional if `$height` is specified.
+ * @type int $height Image height. Optional if `$width` is specified.
+ * @type bool $crop Optional. Whether to crop the image. Default false.
* }
* }
* @return array An array of resized images' metadata by size.
@@ -254,16 +256,15 @@
* Crops Image.
*
* @since 3.5.0
- * @access public
*
- * @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
+ * @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 bool|WP_Error
*/
public function crop( $src_x, $src_y, $src_w, $src_h, $dst_w = null, $dst_h = null, $src_abs = false ) {
// If destination width/height isn't specified, use same as
@@ -300,10 +301,9 @@
* Ported from image-edit.php
*
* @since 3.5.0
- * @access public
*
* @param float $angle
- * @return boolean|WP_Error
+ * @return true|WP_Error
*/
public function rotate( $angle ) {
if ( function_exists('imagerotate') ) {
@@ -326,11 +326,10 @@
* Flips current image.
*
* @since 3.5.0
- * @access public
*
- * @param boolean $horz Flip along Horizontal Axis
- * @param boolean $vert Flip along Vertical Axis
- * @returns boolean|WP_Error
+ * @param bool $horz Flip along Horizontal Axis
+ * @param bool $vert Flip along Vertical Axis
+ * @return true|WP_Error
*/
public function flip( $horz, $vert ) {
$w = $this->size['width'];
@@ -356,7 +355,6 @@
* Saves current in-memory image to file.
*
* @since 3.5.0
- * @access public
*
* @param string|null $filename
* @param string|null $mime_type
@@ -411,7 +409,7 @@
@ chmod( $filename, $perms );
/**
- * Filter the name of the saved image file.
+ * Filters the name of the saved image file.
*
* @since 2.6.0
*
@@ -430,9 +428,9 @@
* Returns stream of current image.
*
* @since 3.5.0
- * @access public
*
- * @param string $mime_type
+ * @param string $mime_type The mime type of the image.
+ * @return bool True on success, false on failure.
*/
public function stream( $mime_type = null ) {
list( $filename, $extension, $mime_type ) = $this->get_output_format( null, $mime_type );
@@ -454,12 +452,11 @@
* Either calls editor's save function or handles file as a stream.
*
* @since 3.5.0
- * @access protected
*
* @param string|stream $filename
* @param callable $function
* @param array $arguments
- * @return boolean
+ * @return bool
*/
protected function make_image( $filename, $function, $arguments ) {
if ( wp_is_stream( $filename ) )