wp/wp-includes/class-wp-image-editor.php
changeset 7 cf61fcea0001
parent 5 5e2f62d02dcd
child 9 177826044cd9
--- a/wp/wp-includes/class-wp-image-editor.php	Tue Jun 09 11:14:17 2015 +0000
+++ b/wp/wp-includes/class-wp-image-editor.php	Mon Oct 14 17:39:30 2019 +0200
@@ -17,10 +17,12 @@
 	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,12 @@
 	 * Must be overridden in a sub-class.
 	 *
 	 * @since 3.5.0
-	 * @access public
+	 *
+	 * @static
 	 * @abstract
 	 *
 	 * @param array $args
-	 * @return boolean
+	 * @return bool
 	 */
 	public static function test( $args = array() ) {
 		return false;
@@ -46,11 +49,12 @@
 	 * Must be overridden in a sub-class.
 	 *
 	 * @since 3.5.0
-	 * @access public
+	 *
+	 * @static
 	 * @abstract
 	 *
 	 * @param string $mime_type
-	 * @return boolean
+	 * @return bool
 	 */
 	public static function supports_mime_type( $mime_type ) {
 		return false;
@@ -60,10 +64,9 @@
 	 * Loads image from $this->file into editor.
 	 *
 	 * @since 3.5.0
-	 * @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();
 
@@ -71,7 +74,6 @@
 	 * Saves current image to file.
 	 *
 	 * @since 3.5.0
-	 * @access public
 	 * @abstract
 	 *
 	 * @param string $destfilename
@@ -88,13 +90,12 @@
 	 * maintain aspect ratio according to the provided dimension.
 	 *
 	 * @since 3.5.0
-	 * @access public
 	 * @abstract
 	 *
 	 * @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 );
 
@@ -102,7 +103,6 @@
 	 * Resize multiple images from a single source.
 	 *
 	 * @since 3.5.0
-	 * @access public
 	 * @abstract
 	 *
 	 * @param array $sizes {
@@ -122,7 +122,6 @@
 	 * Crops Image.
 	 *
 	 * @since 3.5.0
-	 * @access public
 	 * @abstract
 	 *
 	 * @param int $src_x The start x position to crop from.
@@ -131,8 +130,8 @@
 	 * @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 );
 
@@ -140,11 +139,10 @@
 	 * Rotates current image counter-clockwise by $angle.
 	 *
 	 * @since 3.5.0
-	 * @access public
 	 * @abstract
 	 *
 	 * @param float $angle
-	 * @return boolean|WP_Error
+	 * @return bool|WP_Error
 	 */
 	abstract public function rotate( $angle );
 
@@ -152,12 +150,11 @@
 	 * Flips current image.
 	 *
 	 * @since 3.5.0
-	 * @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 );
 
@@ -165,11 +162,10 @@
 	 * Streams current image to browser.
 	 *
 	 * @since 3.5.0
-	 * @access public
 	 * @abstract
 	 *
-	 * @param string $mime_type
-	 * @return boolean|WP_Error
+	 * @param string $mime_type The mime type of the image.
+	 * @return bool|WP_Error True on success, WP_Error object or false on failure.
 	 */
 	abstract public function stream( $mime_type = null );
 
@@ -177,7 +173,6 @@
 	 * Gets dimensions of image.
 	 *
 	 * @since 3.5.0
-	 * @access public
 	 *
 	 * @return array {'width'=>int, 'height'=>int}
 	 */
@@ -189,7 +184,6 @@
 	 * Sets current image size.
 	 *
 	 * @since 3.5.0
-	 * @access protected
 	 *
 	 * @param int $width
 	 * @param int $height
@@ -207,7 +201,6 @@
 	 * Gets the Image Compression quality on a 1-100% scale.
 	 *
 	 * @since 4.0.0
-	 * @access public
 	 *
 	 * @return int $quality Compression Quality. Range: [1,100]
 	 */
@@ -223,15 +216,14 @@
 	 * Sets Image Compression quality on a 1-100% scale.
 	 *
 	 * @since 3.5.0
-	 * @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 +239,7 @@
 
 			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 +262,7 @@
 			}
 		}
 
-		// 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;
 		}
@@ -292,7 +284,6 @@
 	 * Provides corrected filename only if filename is provided.
 	 *
 	 * @since 3.5.0
-	 * @access protected
 	 *
 	 * @param string $filename
 	 * @param string $mime_type
@@ -327,7 +318,7 @@
 		// 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 +331,8 @@
 		}
 
 		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}";
 		}
@@ -357,7 +344,6 @@
 	 * Builds an output filename based on current file, and adding proper suffix
 	 *
 	 * @since 3.5.0
-	 * @access public
 	 *
 	 * @param string $suffix
 	 * @param string $dest_path
@@ -369,9 +355,8 @@
 		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 );
@@ -386,7 +371,6 @@
 	 * Builds and returns proper suffix for file based on height and width.
 	 *
 	 * @since 3.5.0
-	 * @access public
 	 *
 	 * @return false|string suffix
 	 */
@@ -401,12 +385,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 ( $stream = wp_is_stream( $filename ) ) {
@@ -442,10 +425,11 @@
 	 * as mapped from wp_get_mime_types()
 	 *
 	 * @since 3.5.0
-	 * @access protected
+	 *
+	 * @static
 	 *
 	 * @param string $extension
-	 * @return string|boolean
+	 * @return string|false
 	 */
 	protected static function get_mime_type( $extension = null ) {
 		if ( ! $extension )
@@ -454,7 +438,7 @@
 		$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 +452,11 @@
 	 * as mapped from wp_get_mime_types()
 	 *
 	 * @since 3.5.0
-	 * @access protected
+	 *
+	 * @static
 	 *
 	 * @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() ) );