Changeset 55935

Timestamp:

06/18/2023 02:22:40 PM (3 years ago)

Author:

azaozz

Message:

Media: Deprecate the 'edit_custom_thumbnail_sizes' filter and disable the "Apply changes to [Thumbnail|All|All except thumbnail]" UI in the image editor. Add a (boolean) filter to reenable that UI.

Props peterwilsoncc, costdev, azaozz.
See: #57685.

Location:

trunk

Files:

• src/js/_enqueues/lib/image-edit.js (modified) (1 diff)
• src/wp-admin/includes/image-edit.php (modified) (8 diffs)
• tests/phpunit/tests/ajax/wpAjaxImageEditor.php (modified) (1 diff)
• tests/phpunit/tests/image/functions.php (modified) (1 diff)

trunk/src/js/_enqueues/lib/image-edit.js

@@ -359 +359 @@
          *
          * @return {string} The value from the imagedit-save-target input field when available,
-         *                  or 'full' when not available.
-         */
-        getTarget : function(postid) {
-                return $('input[name="imgedit-target-' + postid + '"]:checked', '#imgedit-save-target-' + postid).val() || 'full';
+         *                  'full' when not selected, or 'all' if it doesn't exist.
+         */
+        getTarget : function( postid ) {
+                var element = $( '#imgedit-save-target-' + postid );
+
+                if ( element.length ) {
+                        return element.find( 'input[name="imgedit-target-' + postid + '"]:checked' ).val() || 'full';
+                }
+
+                return 'all';
         },
 

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

@@ -44 +44 @@
                 }
         }
-        $edit_custom_sizes = false;
+
         /**
-         * Filters whether custom sizes are available options for image editing.
+         * Shows the settings in the Image Editor that allow selecting to edit only the thumbnail of an image.
          *
-         * @since 6.0.0
+         * @since 6.3.0
          *
-         * @param bool|string[] $edit_custom_sizes True if custom sizes can be edited or array of custom size names.
+         * @param bool Whether to show the settings in the Image Editor. Default false.
          */
-        $edit_custom_sizes = apply_filters( 'edit_custom_thumbnail_sizes', $edit_custom_sizes );
+        $edit_thumbnails_separately = (bool) apply_filters( 'image_edit_thumbnails_separately', false );
+
         ?>
         <div class="imgedit-wrap wp-clearfix">
@@ -273 +274 @@
 
         <?php
-        if ( $thumb && $sub_sizes ) {
+        if ( $edit_thumbnails_separately && $thumb && $sub_sizes ) {
                 $thumb_img = wp_constrain_dimensions( $thumb['width'], $thumb['height'], 160, 120 );
                 ?>
@@ -308 +309 @@
                                         <label for="imgedit-target-thumbnail"><?php _e( 'Thumbnail' ); ?></label>
                                 </span>
- 
+
                                 <span class="imgedit-label">
                                         <input type="radio" id="imgedit-target-nothumb" name="imgedit-target-<?php echo $post_id; ?>" value="nothumb" />
@@ -314 +315 @@
                                 </span>
 
-                                <?php
-                                if ( $edit_custom_sizes ) {
-                                        if ( ! is_array( $edit_custom_sizes ) ) {
-                                                $edit_custom_sizes = get_intermediate_image_sizes();
-                                        }
-                                        foreach ( array_unique( $edit_custom_sizes ) as $key => $size ) {
-                                                if ( array_key_exists( $size, $meta['sizes'] ) ) {
-                                                        if ( 'thumbnail' === $size ) {
-                                                                continue;
-                                                        }
-                                                        ?>
-                                                        <span class="imgedit-label">
-                                                        <input type="radio" id="imgedit-target-custom<?php echo esc_attr( $key ); ?>" name="imgedit-target-<?php echo $post_id; ?>" value="<?php echo esc_attr( $size ); ?>" />
-                                                                <label for="imgedit-target-custom<?php echo esc_attr( $key ); ?>"><?php echo esc_html( $size ); ?></label>
-                                                        </span>
-                                                        <?php
-                                                }
-                                        }
-                                }
-                                ?>
                                 </fieldset>
                         </div>
@@ -919 +900 @@
         $scale   = ! empty( $_REQUEST['do'] ) && 'scale' === $_REQUEST['do'];
 
+        /** This filter is documented in wp-admin/includes/image-edit.php */
+        $edit_thumbnails_separately = (bool) apply_filters( 'image_edit_thumbnails_separately', false );
+
         if ( $scale ) {
                 $size = $img->get_size();
@@ -978 +962 @@
                 isset( $backup_sizes['full-orig'] ) && $backup_sizes['full-orig']['file'] != $basename ) {
 
-                if ( 'thumbnail' === $target ) {
+                if ( $edit_thumbnails_separately && 'thumbnail' === $target ) {
                         $new_path = "{$dirname}/{$filename}-temp.{$ext}";
                 } else {
@@ -1028 +1012 @@
                 $meta['height'] = $size['height'];
 
-                if ( $success ) {
+                if ( $success && ( 'nothumb' === $target || 'all' === $target ) ) {
                         $sizes = get_intermediate_image_sizes();
-                        if ( 'nothumb' === $target || 'all' === $target ) {
-                                if ( 'nothumb' === $target ) {
-                                        $sizes = array_diff( $sizes, array( 'thumbnail' ) );
-                                }
-                        } elseif ( 'thumbnail' !== $target ) {
-                                $sizes = array_diff( $sizes, array( $target ) );
+
+                        if ( $edit_thumbnails_separately && 'nothumb' === $target ) {
+                                $sizes = array_diff( $sizes, array( 'thumbnail' ) );
                         }
                 }
@@ -1041 +1022 @@
                 $return->fw = $meta['width'];
                 $return->fh = $meta['height'];
-        } elseif ( 'thumbnail' === $target ) {
+        } elseif ( $edit_thumbnails_separately && 'thumbnail' === $target ) {
                 $sizes   = array( 'thumbnail' );
                 $success = true;
                 $delete  = true;
                 $nocrop  = true;
-        } else {
-                $sizes   = array( $target );
-                $success = true;
-                $delete  = true;
-                $nocrop  = $_wp_additional_image_sizes[ $size ]['crop'];
         }
 

trunk/tests/phpunit/tests/ajax/wpAjaxImageEditor.php

@@ -27 +27 @@
                 $this->remove_added_uploads();
                 parent::tear_down();
-        }
-
-        /**
-         * @ticket 22985
-         * @requires function imagejpeg
-         *
-         * @covers ::wp_insert_attachment
-         * @covers ::wp_save_image
-         */
-        public function testCropImageThumbnail() {
-                require_once ABSPATH . 'wp-admin/includes/image-edit.php';
-
-                $filename = DIR_TESTDATA . '/images/canola.jpg';
-                $contents = file_get_contents( $filename );
-
-                $upload = wp_upload_bits( wp_basename( $filename ), null, $contents );
-                $id     = $this->_make_attachment( $upload );
-
-                $_REQUEST['action']  = 'image-editor';
-                $_REQUEST['context'] = 'edit-attachment';
-                $_REQUEST['postid']  = $id;
-                $_REQUEST['target']  = 'thumbnail';
-                $_REQUEST['do']      = 'save';
-                $_REQUEST['history'] = '[{"c":{"x":5,"y":8,"w":289,"h":322}}]';
-
-                $media_meta = wp_get_attachment_metadata( $id );
-                $this->assertArrayHasKey( 'sizes', $media_meta, 'attachment should have size data' );
-                $this->assertArrayHasKey( 'medium', $media_meta['sizes'], 'attachment should have data for medium size' );
-                $ret = wp_save_image( $id );
-
-                $media_meta = wp_get_attachment_metadata( $id );
-                $this->assertArrayHasKey( 'sizes', $media_meta, 'cropped attachment should have size data' );
-                $this->assertArrayHasKey( 'medium', $media_meta['sizes'], 'cropped attachment should have data for medium size' );
         }
 

trunk/tests/phpunit/tests/image/functions.php

@@ -349 +349 @@
 
                 $this->assertTrue( $ret, 'Image failed to save.' );
+        }
+
+        /**
+         * Tests that `wp_image_editor()` applies 'image_edit_thumbnails_separately' filters.
+         *
+         * @ticket 53161
+         *
+         * @covers ::wp_image_editor
+         */
+        public function test_wp_image_editor_should_apply_image_edit_thumbnails_separately_filters() {
+                require_once ABSPATH . 'wp-admin/includes/image-edit.php';
+
+                $filename = DIR_TESTDATA . '/images/canola.jpg';
+                $contents = file_get_contents( $filename );
+                $upload   = wp_upload_bits( wp_basename( $filename ), null, $contents );
+                $id       = $this->_make_attachment( $upload );
+
+                $filter = new MockAction();
+                add_filter( 'image_edit_thumbnails_separately', array( &$filter, 'filter' ) );
+
+                ob_start();
+                wp_image_editor( $id );
+                ob_end_clean();
+
+                $this->assertSame( 1, $filter->get_call_count() );
+        }
+
+        /**
+         * Tests that `wp_image_editor()` conditionally outputs markup for editing thumbnails separately
+         * based on the result of applying 'image_edit_thumbnails_separately' filters.
+         *
+         * @ticket 53161
+         *
+         * @covers ::wp_image_editor
+         *
+         * @dataProvider data_wp_image_editor_should_respect_image_edit_thumbnails_separately_filters
+         *
+         * @param string $callback The name of the callback for the 'image_edit_thumbnails_separately' hook.
+         * @param bool   $expected Whether the markup should be output.
+         */
+        public function test_wp_image_editor_should_respect_image_edit_thumbnails_separately_filters( $callback, $expected ) {
+                require_once ABSPATH . 'wp-admin/includes/image-edit.php';
+
+                $filename = DIR_TESTDATA . '/images/canola.jpg';
+                $contents = file_get_contents( $filename );
+                $upload   = wp_upload_bits( wp_basename( $filename ), null, $contents );
+                $id       = $this->_make_attachment( $upload );
+
+                add_filter( 'image_edit_thumbnails_separately', $callback );
+
+                ob_start();
+                wp_image_editor( $id );
+                $actual = ob_get_clean();
+
+                if ( $expected ) {
+                        $this->assertStringContainsString(
+                                'imgedit-applyto',
+                                $actual,
+                                'The markup should have been output.'
+                        );
+                } else {
+                        $this->assertStringNotContainsString(
+                                'imgedit-applyto',
+                                $actual,
+                                'The markup should not have been output.'
+                        );
+                }
+        }
+
+        /**
+         * Data provider.
+         *
+         * @return array[]
+         */
+        public function data_wp_image_editor_should_respect_image_edit_thumbnails_separately_filters() {
+                return array(
+                        'true'  => array(
+                                'callback' => '__return_true',
+                                'expected' => true,
+                        ),
+                        'false' => array(
+                                'callback' => '__return_false',
+                                'expected' => false,
+                        ),
+                );
         }