X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/a6f44f0edcda2471c5a33e4156c1c9488c7f3210..refs/tags/wordpress-3.7:/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 3c2e1b3d..81909f89 100644
--- a/wp-includes/class-wp-image-editor.php
+++ b/wp-includes/class-wp-image-editor.php
@@ -94,18 +94,22 @@ abstract class WP_Image_Editor {
 	abstract public function resize( $max_w, $max_h, $crop = false );
 
 	/**
-	 * Processes current image and saves to disk
-	 * multiple sizes from single source.
-	 *
-	 * 'width' and 'height' are required.
-	 * 'crop' defaults to false when not provided.
+	 * Resize multiple images from a single source.
 	 *
 	 * @since 3.5.0
 	 * @access public
 	 * @abstract
 	 *
-	 * @param array $sizes { {'width'=>int, 'height'=>int, ['crop'=>bool]}, ... }
-	 * @return array
+	 * @param array $sizes {
+	 *     An array of image size arrays. Default sizes are 'small', 'medium', 'large'.
+	 *
+	 *     @type array $size {
+	 *         @type int  $width  Image width.
+	 *         @type int  $height Image height.
+	 *         @type bool $crop   Optional. Whether to crop the image. Default false.
+	 *     }
+	 * }
+	 * @return array An array of resized images metadata by size.
 	 */
 	abstract public function multi_resize( $sizes );
 
@@ -204,6 +208,13 @@ abstract class WP_Image_Editor {
 	 * @return boolean
 	 */
 	public function set_quality( $quality ) {
+		/**
+		 * Filter the default quality setting.
+		 *
+		 * @since 3.5.0
+		 *
+		 * @param int $quality Quality level between 0 (low) and 100 (high).
+		 */
 		$this->quality = apply_filters( 'wp_editor_set_quality', $quality );
 
 		return ( (bool) $this->quality );
@@ -253,6 +264,15 @@ abstract class WP_Image_Editor {
 		// Double-check that the mime-type selected is supported by the editor.
 		// If not, choose a default instead.
 		if ( ! $this->supports_mime_type( $mime_type ) ) {
+			/**
+			 * Filter default mime type prior to getting the file extension.
+			 *
+			 * @see wp_get_mime_types()
+			 *
+			 * @since 3.5.0
+			 *
+			 * @param string $mime_type Mime type string.
+			 */
 			$mime_type = apply_filters( 'image_editor_default_mime_type', $this->default_mime_type );
 			$new_ext = $this->get_extension( $mime_type );
 		}
@@ -330,8 +350,8 @@ abstract class WP_Image_Editor {
 		if ( $stream = wp_is_stream( $filename ) ) {
 			ob_start();
 		} else {
-			// The directory containing the original file may no longer exist when using a replication plugin. 
-			wp_mkdir_p( dirname( $filename ) ); 
+			// The directory containing the original file may no longer exist when using a replication plugin.
+			wp_mkdir_p( dirname( $filename ) );
 		}
 
 		$result = call_user_func_array( $function, $arguments );