Changeset 27357

Timestamp:

03/02/2014 08:55:10 PM (11 years ago)

Author:

DrewAPicture

Message:

Inline documentation for hooks in wp-admin/includes/image-edit.php.

Props theorboman. Props kpdesign for the cleanup.
Fixes #26149.

File:

• trunk/src/wp-admin/includes/image-edit.php (modified) (9 diffs)

trunk/src/wp-admin/includes/image-edit.php

@@ -204 +204 @@
 function wp_stream_image( $image, $mime_type, $post_id ) {
     if ( $image instanceof WP_Image_Editor ) {
-        $image = apply_filters('image_editor_save_pre', $image, $post_id);
+
+        /**
+         * Filter the WP_Image_Editor instance for the image to be streamed to the browser.
+         *
+         * @since 3.5.0
+         *
+         * @param WP_Image_Editor $image   WP_Image_Editor instance.
+         * @param int             $post_id Post ID.
+         */
+        $image = apply_filters( 'image_editor_save_pre', $image, $post_id );
 
         if ( is_wp_error( $image->stream( $mime_type ) ) )
@@ -213 +222 @@
         _deprecated_argument( __FUNCTION__, '3.5', __( '$image needs to be an WP_Image_Editor object' ) );
 
-        $image = apply_filters('image_save_pre', $image, $post_id);
+        /**
+         * Filter the GD image resource to be streamed to the browser.
+         *
+         * @since 2.9.0
+         * @deprecated 3.5.0 Use image_editor_save_pre instead.
+         *
+         * @param resource $image   Image resource to be streamed.
+         * @param int      $post_id Post ID.
+         */
+        $image = apply_filters( 'image_save_pre', $image, $post_id );
 
         switch ( $mime_type ) {
@@ -242 +260 @@
 function wp_save_image_file( $filename, $image, $mime_type, $post_id ) {
     if ( $image instanceof WP_Image_Editor ) {
-        $image = apply_filters('image_editor_save_pre', $image, $post_id);
-        $saved = apply_filters('wp_save_image_editor_file', null, $filename, $image, $mime_type, $post_id);
+
+        /** This filter is documented in wp-admin/includes/image-edit.php */
+        $image = apply_filters( 'image_editor_save_pre', $image, $post_id );
+
+        /**
+         * Filter whether to skip saving the image file.
+         *
+         * Returning a non-null value will short-circuit the save method,
+         * returning that value instead.
+         *
+         * @since 3.5.0
+         *
+         * @param mixed           $override  Value to return instead of saving. Default null.
+         * @param string          $filename  Name of the file to be saved.
+         * @param WP_Image_Editor $image     WP_Image_Editor instance.
+         * @param string          $mime_type Image mime type.
+         * @param int             $post_id   Post ID.
+         */
+        $saved = apply_filters( 'wp_save_image_editor_file', null, $filename, $image, $mime_type, $post_id );
 
         if ( null !== $saved )
@@ -252 +287 @@
         _deprecated_argument( __FUNCTION__, '3.5', __( '$image needs to be an WP_Image_Editor object' ) );
 
-        $image = apply_filters('image_save_pre', $image, $post_id);
-        $saved = apply_filters('wp_save_image_file', null, $filename, $image, $mime_type, $post_id);
+        /** This filter is documented in wp-admin/includes/image-edit.php */
+        $image = apply_filters( 'image_save_pre', $image, $post_id );
+
+        /**
+         * Filter whether to skip saving the image file.
+         *
+         * Returning a non-null value will short-circuit the save method,
+         * returning that value instead.
+         *
+         * @since 2.9.0
+         * @deprecated 3.5.0 Use wp_save_image_editor_file instead.
+         *
+         * @param mixed           $override  Value to return instead of saving. Default null.
+         * @param string          $filename  Name of the file to be saved.
+         * @param WP_Image_Editor $image     WP_Image_Editor instance.
+         * @param string          $mime_type Image mime type.
+         * @param int             $post_id   Post ID.
+         */
+        $saved = apply_filters( 'wp_save_image_file', null, $filename, $image, $mime_type, $post_id );
 
         if ( null !== $saved )
@@ -260 +312 @@
         switch ( $mime_type ) {
             case 'image/jpeg':
+
                 /** This filter is documented in wp-includes/class-wp-image-editor.php */
                 return imagejpeg( $image, $filename, apply_filters( 'jpeg_quality', 90, 'edit_image' ) );
@@ -399 +452 @@
 
     // image resource before applying the changes
-    if ( $image instanceof WP_Image_Editor )
-        $image = apply_filters('wp_image_editor_before_change', $image, $changes);
-    elseif ( is_resource( $image ) )
-        $image = apply_filters('image_edit_before_change', $image, $changes);
+    if ( $image instanceof WP_Image_Editor ) {
+
+        /**
+         * Filter the WP_Image_Editor instance before applying changes to the image.
+         *
+         * @since 3.5.0
+         *
+         * @param WP_Image_Editor $image   WP_Image_Editor instance.
+         * @param array           $changes Array of change operations.
+         */
+        $image = apply_filters( 'wp_image_editor_before_change', $image, $changes );
+    } elseif ( is_resource( $image ) ) {
+
+        /**
+         * Filter the GD image resource before applying changes to the image.
+         *
+         * @since 2.9.0
+         * @deprecated 3.5.0 Use wp_image_editor_before_change instead.
+         *
+         * @param resource $image   GD image resource.
+         * @param array    $changes Array of change operations.
+         */
+        $image = apply_filters( 'image_edit_before_change', $image, $changes );
+    }
 
     foreach ( $changes as $operation ) {
@@ -452 +525 @@
 function stream_preview_image( $post_id ) {
     $post = get_post( $post_id );
+
+    /** This filter is documented in wp-admin/admin.php */
     @ini_set( 'memory_limit', apply_filters( 'admin_memory_limit', WP_MAX_MEMORY_LIMIT ) );
 
@@ -501 +576 @@
                 // delete only if it's edited image
                 if ( preg_match('/-e[0-9]{13}\./', $parts['basename']) ) {
+
                     /** This filter is documented in wp-admin/custom-header.php */
-                    $delpath = apply_filters('wp_delete_file', $file);
+                    $delpath = apply_filters( 'wp_delete_file', $file );
                     @unlink($delpath);
                 }
@@ -726 +802 @@
 
     if ( $delete ) {
+
         /** This filter is documented in wp-admin/custom-header.php */
-        $delpath = apply_filters('wp_delete_file', $new_path);
+        $delpath = apply_filters( 'wp_delete_file', $new_path );
         @unlink( $delpath );
     }