X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/849f15aeed7a5e39314057bdc0064d8edd60dd7d..e3ff8f35458a959c1879c0a4976701ed8dcfe651:/wp-includes/class-wp-image-editor.php diff --git a/wp-includes/class-wp-image-editor.php b/wp-includes/class-wp-image-editor.php index fcca5574..cc991eb8 100644 --- a/wp-includes/class-wp-image-editor.php +++ b/wp-includes/class-wp-image-editor.php @@ -17,10 +17,12 @@ abstract class WP_Image_Editor { protected $mime_type = null; protected $default_mime_type = 'image/jpeg'; protected $quality = false; - protected $default_quality = 90; + protected $default_quality = 82; /** * Each instance handles a single file. + * + * @param string $file Path to the file to load. */ public function __construct( $file ) { $this->file = $file; @@ -31,11 +33,13 @@ abstract class WP_Image_Editor { * Must be overridden in a sub-class. * * @since 3.5.0 + * + * @static * @access public * @abstract * * @param array $args - * @return boolean + * @return bool */ public static function test( $args = array() ) { return false; @@ -46,11 +50,13 @@ abstract class WP_Image_Editor { * Must be overridden in a sub-class. * * @since 3.5.0 + * + * @static * @access public * @abstract * * @param string $mime_type - * @return boolean + * @return bool */ public static function supports_mime_type( $mime_type ) { return false; @@ -63,7 +69,7 @@ abstract class WP_Image_Editor { * @access protected * @abstract * - * @return boolean|WP_Error True if loaded; WP_Error on failure. + * @return bool|WP_Error True if loaded; WP_Error on failure. */ abstract public function load(); @@ -93,8 +99,8 @@ abstract class WP_Image_Editor { * * @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 bool|WP_Error */ abstract public function resize( $max_w, $max_h, $crop = false ); @@ -125,15 +131,14 @@ abstract class WP_Image_Editor { * @access public * @abstract * - * @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 + * @param bool $src_abs Optional. If the source crop points are absolute. + * @return bool|WP_Error */ abstract public function crop( $src_x, $src_y, $src_w, $src_h, $dst_w = null, $dst_h = null, $src_abs = false ); @@ -145,7 +150,7 @@ abstract class WP_Image_Editor { * @abstract * * @param float $angle - * @return boolean|WP_Error + * @return bool|WP_Error */ abstract public function rotate( $angle ); @@ -156,9 +161,9 @@ abstract class WP_Image_Editor { * @access public * @abstract * - * @param boolean $horz Flip along Horizontal Axis - * @param boolean $vert Flip along Vertical Axis - * @return boolean|WP_Error + * @param bool $horz Flip along Horizontal Axis + * @param bool $vert Flip along Vertical Axis + * @return bool|WP_Error */ abstract public function flip( $horz, $vert ); @@ -170,7 +175,7 @@ abstract class WP_Image_Editor { * @abstract * * @param string $mime_type - * @return boolean|WP_Error + * @return bool|WP_Error */ abstract public function stream( $mime_type = null ); @@ -194,6 +199,7 @@ abstract class WP_Image_Editor { * * @param int $width * @param int $height + * @return true */ protected function update_size( $width = null, $height = null ) { $this->size = array( @@ -226,12 +232,12 @@ abstract class WP_Image_Editor { * @access public * * @param int $quality Compression Quality. Range: [1,100] - * @return boolean|WP_Error True if set successfully; WP_Error on failure. + * @return true|WP_Error True if set successfully; WP_Error on failure. */ public function set_quality( $quality = null ) { if ( null === $quality ) { /** - * Filter the default image compression quality setting. + * Filters the default image compression quality setting. * * Applies only during initial editor instantiation, or when set_quality() is run * manually without the `$quality` argument. @@ -247,7 +253,7 @@ abstract class WP_Image_Editor { if ( 'image/jpeg' == $this->mime_type ) { /** - * Filter the JPEG compression quality for backward-compatibility. + * Filters the JPEG compression quality for backward-compatibility. * * Applies only during initial editor instantiation, or when set_quality() is run * manually without the `$quality` argument. @@ -270,7 +276,7 @@ abstract class WP_Image_Editor { } } - // Allow 0, but squash to 1 due to identical images in GD, and for backwards compatibility. + // Allow 0, but squash to 1 due to identical images in GD, and for backward compatibility. if ( 0 === $quality ) { $quality = 1; } @@ -327,7 +333,7 @@ abstract class WP_Image_Editor { // If not, choose a default instead. if ( ! $this->supports_mime_type( $mime_type ) ) { /** - * Filter default mime type prior to getting the file extension. + * Filters default mime type prior to getting the file extension. * * @see wp_get_mime_types() * @@ -340,12 +346,8 @@ abstract class WP_Image_Editor { } if ( $filename ) { - $ext = ''; - $info = pathinfo( $filename ); - $dir = $info['dirname']; - - if( isset( $info['extension'] ) ) - $ext = $info['extension']; + $dir = pathinfo( $filename, PATHINFO_DIRNAME ); + $ext = pathinfo( $filename, PATHINFO_EXTENSION ); $filename = trailingslashit( $dir ) . wp_basename( $filename, ".$ext" ) . ".{$new_ext}"; } @@ -369,9 +371,8 @@ abstract class WP_Image_Editor { if ( ! $suffix ) $suffix = $this->get_suffix(); - $info = pathinfo( $this->file ); - $dir = $info['dirname']; - $ext = $info['extension']; + $dir = pathinfo( $this->file, PATHINFO_DIRNAME ); + $ext = pathinfo( $this->file, PATHINFO_EXTENSION ); $name = wp_basename( $this->file, ".$ext" ); $new_ext = strtolower( $extension ? $extension : $ext ); @@ -388,7 +389,7 @@ abstract class WP_Image_Editor { * @since 3.5.0 * @access public * - * @return string suffix + * @return false|string suffix */ public function get_suffix() { if ( ! $this->get_size() ) @@ -406,7 +407,7 @@ abstract class WP_Image_Editor { * @param string|stream $filename * @param callable $function * @param array $arguments - * @return boolean + * @return bool */ protected function make_image( $filename, $function, $arguments ) { if ( $stream = wp_is_stream( $filename ) ) { @@ -442,10 +443,12 @@ abstract class WP_Image_Editor { * as mapped from wp_get_mime_types() * * @since 3.5.0 + * + * @static * @access protected * * @param string $extension - * @return string|boolean + * @return string|false */ protected static function get_mime_type( $extension = null ) { if ( ! $extension ) @@ -454,7 +457,7 @@ abstract class WP_Image_Editor { $mime_types = wp_get_mime_types(); $extensions = array_keys( $mime_types ); - foreach( $extensions as $_extension ) { + foreach ( $extensions as $_extension ) { if ( preg_match( "/{$extension}/i", $_extension ) ) { return $mime_types[$_extension]; } @@ -468,10 +471,12 @@ abstract class WP_Image_Editor { * as mapped from wp_get_mime_types() * * @since 3.5.0 + * + * @static * @access protected * * @param string $mime_type - * @return string|boolean + * @return string|false */ protected static function get_extension( $mime_type = null ) { $extensions = explode( '|', array_search( $mime_type, wp_get_mime_types() ) );