Ticket #25832: 25832.2.diff

wp-admin/includes/image.php

@@ -102 +102 @@
                                 $sizes[$s]['crop'] = get_option( "{$s}_crop" ); // For default sizes set in options
                 }
 
+                /**
+                 * Filter the image sizes automatically generated when uploading an image.
+                 *
+                 * @since 2.9.0
+                 *
+                 * @param array $sizes Array of image sizes.
+                 */
                 $sizes = apply_filters( 'intermediate_image_sizes_advanced', $sizes );
 
                 if ( $sizes ) {
@@ -155 +162 @@
         if ( isset( $metadata['image']['data'] ) )
                 unset( $metadata['image']['data'] );
 
+        /**
+         * Filter the attachment metadata.
+         *
+         * @since 2.1.0
+         *
+         * @param array $metadata      Attachment metadata.
+         * @param int   $attachment_id Attachment ID.
+         */
         return apply_filters( 'wp_generate_attachment_metadata', $metadata, $attachment_id );
 }
 
@@ -268 +283 @@
                  }
         }
 
+        /**
+         * Filter the image types for which to check for exif data.
+         *
+         * @since 2.5.0
+         *
+         * @param array Image types to check for exit data.
+         */
         // fetch additional info from exif if available
         if ( is_callable( 'exif_read_data' ) && in_array( $sourceImageType, apply_filters( 'wp_read_image_metadata_types', array( IMAGETYPE_JPEG, IMAGETYPE_TIFF_II, IMAGETYPE_TIFF_MM ) ) ) ) {
                 $exif = @exif_read_data( $file );
@@ -316 +338 @@
                         $meta[ $key ] = utf8_encode( $meta[ $key ] );
         }
 
+        /**
+         * Filter the returned image metadata.
+         *
+         * @since 2.5.0
+         *
+         * @param array  $meta            Image metadata.
+         * @param string $file            Path to image file.
+         * @param int    $sourceImageType Type of image @see http://php.net/manual/en/function.getimagesize.php.
+         */
         return apply_filters( 'wp_read_image_metadata', $meta, $file, $sourceImageType );
 
 }
@@ -351 +382 @@
         else
                 $result = true;
 
+        /**
+         * Filter the result as to whether or not the image is displayable in a web browser.
+         *
+         * @since 2.5.0
+         *
+         * @param bool   $result Whether or not the image can be displayed.
+         * @param string $path   Path to the image.
+         */
         return apply_filters('file_is_displayable_image', $result, $path);
 }
 
@@ -384 +423 @@
                         break;
         }
         if ( is_resource($image) ) {
+
+                /**
+                 * Filter the image resource to be edited.
+                 *
+                 * @since 2.9.0
+                 *
+                 * @param resource $image         Image resource.
+                 * @param string   $attachment_id Attachment ID.
+                 * @param string   $size          Size of the image.
+                 */
                 $image = apply_filters('load_image_to_edit', $image, $attachment_id, $size);
                 if ( function_exists('imagealphablending') && function_exists('imagesavealpha') ) {
                         imagealphablending($image, false);
@@ -411 +460 @@
 
         if ( $filepath && file_exists( $filepath ) ) {
                 if ( 'full' != $size && ( $data = image_get_intermediate_size( $attachment_id, $size ) ) ) {
+
+                /**
+                 * Filter the path to the image.
+                 *
+                 * @since 3.1.0
+                 *
+                 * @param string                Path to the image.
+                 * @param string $attachment_id Attachment ID.
+                 * @param string $size          Size of the image.
+                 */
                         $filepath = apply_filters( 'load_image_to_edit_filesystempath', path_join( dirname( $filepath ), $data['file'] ), $attachment_id, $size );
                 }
         } elseif ( function_exists( 'fopen' ) && function_exists( 'ini_get' ) && true == ini_get( 'allow_url_fopen' ) ) {
+
+                /* Filter the url to the image if not on the local filesystem.
+                 *
+                 * @since 3.1.0
+                 *
+                 * @param string                Image url.
+                 * @param string $attachment_id Attachment ID.
+                 * @param string $size          Size of the image.
+                 */
                 $filepath = apply_filters( 'load_image_to_edit_attachmenturl', wp_get_attachment_url( $attachment_id ), $attachment_id, $size );
         }
 
+        /**
+         * Filter the returned path or url of the image.
+         *
+         * @since 2.9.0
+         *
+         * @param string|false $filepath      Filepath or url to image or false.
+         * @param string       $attachment_id Attachment ID.
+         * @param string       $size          Size of the image.
+         */
         return apply_filters( 'load_image_to_edit_path', $filepath, $attachment_id, $size );
 }