WordPress.org

Make WordPress Core

Ticket #26149: 26149-1.patch

File 26149-1.patch, 4.7 KB (added by theorboman, 8 years ago)

Updated patch for wp-admin/includes/image-edit.php. Added periods after variable descriptions as per standards. Also note that 'admin_memory_limit' is documented in wp-includes/class-wp-image-editor-imagick.php (see https://core.trac.wordpress.org/ticket/26177)

  • wp-admin/includes/image-edit.php

     
    203203 */
    204204function wp_stream_image( $image, $mime_type, $post_id ) {
    205205        if ( $image instanceof WP_Image_Editor ) {
     206                /**
     207                 * Filter the WP_Image_Editor instance for the image to be streamed to the browser.
     208                 *
     209                 * @since 3.5.0
     210                 *
     211                 * @param WP_Image_Editor       $image          WP_Image_Editor instance.
     212                 * @param int                           $post_id        Post id.
     213                 */
    206214                $image = apply_filters('image_editor_save_pre', $image, $post_id);
    207215
    208216                if ( is_wp_error( $image->stream( $mime_type ) ) )
     
    212220        } else {
    213221                _deprecated_argument( __FUNCTION__, '3.5', __( '$image needs to be an WP_Image_Editor object' ) );
    214222
     223                /**
     224                 * Filter the GD image resource to be streamed to the browser.
     225                 *
     226                 * @since 2.9.0
     227                 *
     228                 * @param resource  $image              Image resource to be streamed.
     229                 * @param int           $post_id        Post id.
     230                 */
    215231                $image = apply_filters('image_save_pre', $image, $post_id);
    216 
    217232                switch ( $mime_type ) {
    218233                        case 'image/jpeg':
    219234                                header( 'Content-Type: image/jpeg' );
     
    241256 */
    242257function wp_save_image_file( $filename, $image, $mime_type, $post_id ) {
    243258        if ( $image instanceof WP_Image_Editor ) {
     259                /**
     260                 * Filter the WP_Image_Editor instance for the image to be saved.
     261                 *
     262                 * @since 3.5.0
     263                 *
     264                 * @param WP_Image_Editor       $image          WP_Image_Editor instance.
     265                 * @param int                           $post_id        Post id.
     266                 */
    244267                $image = apply_filters('image_editor_save_pre', $image, $post_id);
     268
     269                /**
     270                 *
     271                 * This filter changes the returned value of the function and returns
     272                 * the function before invoking the WP_Image_Editor::save method.
     273                 *
     274                 * @since 3.5.0
     275                 *
     276                 * @param                                                               Value for the function to return.
     277                 * @param string                        $filename       Name of the file to be saved.
     278                 * @param WP_Image_Editor       $image          WP_Image_Editor instance.
     279                 * @param string                        $mime_type      Image Mime Type.
     280                 * @param int                           $post_id        Post id.
     281                 */
    245282                $saved = apply_filters('wp_save_image_editor_file', null, $filename, $image, $mime_type, $post_id);
    246283
    247284                if ( null !== $saved )
     
    251288        } else {
    252289                _deprecated_argument( __FUNCTION__, '3.5', __( '$image needs to be an WP_Image_Editor object' ) );
    253290
     291                /**
     292                 * Filter the GD image resource to be saved.
     293                 *
     294                 * @since 2.9.0
     295                 *
     296                 * @param resource  $image              GD image resource to be saved.
     297                 * @param int           $post_id        Post id.
     298                 */
    254299                $image = apply_filters('image_save_pre', $image, $post_id);
     300
     301                /**
     302                 * This filter changes the returned value of the function and returns
     303                 * the function before invoking the GD image creation functions.
     304                 *
     305                 * @since 2.9.0
     306                 *
     307                 * @param                                                               Value for the function to return.
     308                 * @param string                        $filename       Name of the file to be saved.
     309                 * @param WP_Image_Editor       $image          WP_Image_Editor instance.
     310                 * @param string                        $mime_type      Image Mime Type.
     311                 * @param int                           $post_id        Post id.
     312                 */
    255313                $saved = apply_filters('wp_save_image_file', null, $filename, $image, $mime_type, $post_id);
    256314
    257315                if ( null !== $saved )
     
    259317
    260318                switch ( $mime_type ) {
    261319                        case 'image/jpeg':
     320                                /** This filter is documented in wp-includes/class-wp-image-editor-imagick.php */
    262321                                return imagejpeg( $image, $filename, apply_filters( 'jpeg_quality', 90, 'edit_image' ) );
    263322                        case 'image/png':
    264323                                return imagepng( $image, $filename );
     
    397456        }
    398457
    399458        // image resource before applying the changes
    400         if ( $image instanceof WP_Image_Editor )
     459        if ( $image instanceof WP_Image_Editor ) {
     460                /**
     461                 * Filter the WP_Image_Editor instance before applying changes to the image.
     462                 *
     463                 * @since 3.5.0
     464                 *
     465                 * @param WP_Image_Editor       $image          WP_Image_Editor instance.
     466                 * @param array                         $changes        Array of change operations.
     467                 */
    401468                $image = apply_filters('wp_image_editor_before_change', $image, $changes);
    402         elseif ( is_resource( $image ) )
     469        } elseif ( is_resource( $image ) ) {
     470                /**
     471                 * Filter the GD image resource before applying changes to the image.
     472                 *
     473                 * @since 2.9.0
     474                 *
     475                 * @param resource      $image          GD image resource.
     476                 * @param array         $changes        Array of change operations.
     477                 */
    403478                $image = apply_filters('image_edit_before_change', $image, $changes);
     479        }
    404480
    405481        foreach ( $changes as $operation ) {
    406482                switch ( $operation->type ) {
     
    450526 */
    451527function stream_preview_image( $post_id ) {
    452528        $post = get_post( $post_id );
     529        /** This filter is documented in wp-admin/admin.php */
    453530        @ini_set( 'memory_limit', apply_filters( 'admin_memory_limit', WP_MAX_MEMORY_LIMIT ) );
    454531
    455532        $img = wp_get_image_editor( _load_image_to_edit_path( $post_id ) );