Ticket #56288: 56288.5.diff

src/wp-admin/includes/image.php

@@ -672 +672 @@
                 'medium'         => true,
                 'medium_large'   => true,
                 'large'          => true,
-                'post-thumbnail' => true,
         );
 
+        // Include any sizes that were added with `add_image_size`.
+        $additional_image_sizes = array_map(
+                '__return_true',
+                array_filter(
+                        wp_get_additional_image_sizes(),
+                        function( $size ) {
+                                return isset( $size['additional_mimes'] ) && $size['additional_mimes'];
+                        }
+                )
+        );
+        $enabled_sizes          = array_merge( $enabled_sizes, $additional_image_sizes );
+
         /**
          * Filter the sizes that support secondary mime type output. Developers can use this
          * to control the output of additional mime type sub-sized images.

src/wp-content/themes/twentyeleven/functions.php

@@ -227 +227 @@
                  * Add Twenty Eleven's custom image sizes.
                  * Used for large feature (header) images.
                  */
-                add_image_size( 'large-feature', $custom_header_support['width'], $custom_header_support['height'], true );
+                add_image_size( 'large-feature', $custom_header_support['width'], $custom_header_support['height'], true, true );
                 // Used for featured posts if a large-feature doesn't exist.
-                add_image_size( 'small-feature', 500, 300 );
+                add_image_size( 'small-feature', 500, 300, false, true );
 
                 // Default custom headers packaged with the theme. %s is a placeholder for the theme template directory URI.
                 register_default_headers(

src/wp-content/themes/twentyfourteen/functions.php

@@ -122 +122 @@
                 // Enable support for Post Thumbnails, and declare two sizes.
                 add_theme_support( 'post-thumbnails' );
                 set_post_thumbnail_size( 672, 372, true );
-                add_image_size( 'twentyfourteen-full-width', 1038, 576, true );
+                add_image_size( 'twentyfourteen-full-width', 1038, 576, true, true );
 
                 // This theme uses wp_nav_menu() in two locations.
                 register_nav_menus(

src/wp-content/themes/twentyseventeen/functions.php

@@ -56 +56 @@
          */
         add_theme_support( 'post-thumbnails' );
 
-        add_image_size( 'twentyseventeen-featured-image', 2000, 1200, true );
+        add_image_size( 'twentyseventeen-featured-image', 2000, 1200, true, true );
 
-        add_image_size( 'twentyseventeen-thumbnail-avatar', 100, 100, true );
+        add_image_size( 'twentyseventeen-thumbnail-avatar', 100, 100, true, true );
 
         // Set the default content width.
         $GLOBALS['content_width'] = 525;

src/wp-content/themes/twentytwenty/functions.php

@@ -63 +63 @@
         set_post_thumbnail_size( 1200, 9999 );
 
         // Add custom image size used in Cover Template.
-        add_image_size( 'twentytwenty-fullscreen', 1980, 9999 );
+        add_image_size( 'twentytwenty-fullscreen', 1980, 9999, false, true );
 
         // Custom logo.
         $logo_width  = 120;

src/wp-includes/media.php

@@ -275 +275 @@
  * Register a new image size.
  *
  * @since 2.9.0
+ * @since 6.1.0 Add the $additional_mimes parameter.
  *
  * @global array $_wp_additional_image_sizes Associative array of additional image sizes.
  *
- * @param string     $name   Image size identifier.
- * @param int        $width  Optional. Image width in pixels. Default 0.
- * @param int        $height Optional. Image height in pixels. Default 0.
- * @param bool|array $crop   Optional. Image cropping behavior. If false, the image will be scaled (default),
- *                           If true, image will be cropped to the specified dimensions using center positions.
- *                           If an array, the image will be cropped using the array to specify the crop location.
- *                           Array values must be in the format: array( x_crop_position, y_crop_position ) where:
- *                               - x_crop_position accepts: 'left', 'center', or 'right'.
- *                               - y_crop_position accepts: 'top', 'center', or 'bottom'.
+ * @param string     $name             Image size identifier.
+ * @param int        $width            Optional. Image width in pixels. Default 0.
+ * @param int        $height           Optional. Image height in pixels. Default 0.
+ * @param bool|array $crop             Optional. Image cropping behavior. If false, the image will be scaled (default),
+ *                                     If true, image will be cropped to the specified dimensions using center positions.
+ *                                     If an array, the image will be cropped using the array to specify the crop location.
+ *                                     Array values must be in the format: array( x_crop_position, y_crop_position ) where:
+ *                                         - x_crop_position accepts: 'left', 'center', or 'right'.
+ *                                         - y_crop_position accepts: 'top', 'center', or 'bottom'.
+ * @param bool|null  $additional_mimes Optional. Whether to output secondary mimes for this image size. If not passed,
+ *                                     WordPres core will determine whether true or false. Sizes should be registered
+ *                                     with false only if they are not intended for use in a front-end context.
  */
-function add_image_size( $name, $width = 0, $height = 0, $crop = false ) {
+function add_image_size( $name, $width = 0, $height = 0, $crop = false, $additional_mimes = null ) {
         global $_wp_additional_image_sizes;
 
+        // Trigger a warning if the size was registered without providing an `additional_mimes` parameter.
+        if ( null === $additional_mimes ) {
+                _doing_it_wrong(
+                        __FUNCTION__,
+                        sprintf(
+                                /* translators: %s: additional_mimes variable */
+                                __( 'You should provide a boolean value for the %s parameter.' ),
+                                '<code>$additional_mimes</code>'
+                        ),
+                        '6.1.0'
+                );
+                $additional_mimes = false;
+        }
+
         $_wp_additional_image_sizes[ $name ] = array(
-                'width'  => absint( $width ),
-                'height' => absint( $height ),
-                'crop'   => $crop,
+                'width'            => absint( $width ),
+                'height'           => absint( $height ),
+                'crop'             => $crop,
+                'additional_mimes' => $additional_mimes,
         );
 }
 
@@ -345 +364 @@
  *                           An array can specify positioning of the crop area. Default false.
  */
 function set_post_thumbnail_size( $width = 0, $height = 0, $crop = false ) {
-        add_image_size( 'post-thumbnail', $width, $height, $crop );
+        add_image_size( 'post-thumbnail', $width, $height, $crop, true );
 }
 
 /**
@@ -5316 +5335 @@
  */
 function _wp_add_additional_image_sizes() {
         // 2x medium_large size.
-        add_image_size( '1536x1536', 1536, 1536 );
+        add_image_size( '1536x1536', 1536, 1536, false, true );
         // 2x large size.
-        add_image_size( '2048x2048', 2048, 2048 );
+        add_image_size( '2048x2048', 2048, 2048, false, true );
 }
 
 /**

tests/phpunit/tests/image/functions.php

@@ -857 +857 @@
 
                 $this->assertNotEmpty( $attachment_id );
 
-                add_image_size( 'test-size', 100, 100 );
+                add_image_size( 'test-size', 100, 100, false, false );
                 add_filter( 'fallback_intermediate_image_sizes', array( $this, 'filter_fallback_intermediate_image_sizes' ), 10, 2 );
 
                 $metadata = wp_generate_attachment_metadata( $attachment_id, $test_file );

tests/phpunit/tests/image/intermediateSize.php

@@ -93 +93 @@
          * @requires function imagejpeg
          */
         public function test_get_intermediate_sizes_by_name() {
-                add_image_size( 'test-size', 330, 220, true );
+                add_image_size( 'test-size', 330, 220, true, false );
 
                 $file = DIR_TESTDATA . '/images/waffles.jpg';
                 $id   = $this->_make_attachment( $file, 0 );
@@ -115 +115 @@
          */
         public function test_get_intermediate_sizes_by_array_exact() {
                 // Only one dimention match shouldn't return false positive (see: #17626).
-                add_image_size( 'test-size', 330, 220, true );
-                add_image_size( 'false-height', 330, 400, true );
-                add_image_size( 'false-width', 600, 220, true );
+                add_image_size( 'test-size', 330, 220, true, false );
+                add_image_size( 'false-height', 330, 400, true, false );
+                add_image_size( 'false-width', 600, 220, true, false );
 
                 $file = DIR_TESTDATA . '/images/waffles.jpg';
                 $id   = $this->_make_attachment( $file, 0 );
@@ -138 +138 @@
         public function test_get_intermediate_sizes_by_array_nearest() {
                 // If an exact size is not found, it should be returned.
                 // If not, find nearest size that is larger (see: #17626).
-                add_image_size( 'test-size', 450, 300, true );
-                add_image_size( 'false-height', 330, 100, true );
-                add_image_size( 'false-width', 150, 220, true );
+                add_image_size( 'test-size', 450, 300, true, false );
+                add_image_size( 'false-height', 330, 100, true, false );
+                add_image_size( 'false-width', 150, 220, true, false );
 
                 $file = DIR_TESTDATA . '/images/waffles.jpg';
                 $id   = $this->_make_attachment( $file, 0 );
@@ -161 +161 @@
         public function test_get_intermediate_sizes_by_array_nearest_false() {
                 // If an exact size is not found, it should be returned.
                 // If not, find nearest size that is larger, otherwise return false (see: #17626).
-                add_image_size( 'false-height', 330, 100, true );
-                add_image_size( 'false-width', 150, 220, true );
+                add_image_size( 'false-height', 330, 100, true, false );
+                add_image_size( 'false-width', 150, 220, true, false );
 
                 $file = DIR_TESTDATA . '/images/waffles.jpg';
                 $id   = $this->_make_attachment( $file, 0 );
@@ -185 +185 @@
                 $width = 300;
 
                 // Only one dimention match shouldn't return false positive (see: #17626).
-                add_image_size( 'test-size', $width, 0, false );
-                add_image_size( 'false-height', $width, 100, true );
+                add_image_size( 'test-size', $width, 0, false, false );
+                add_image_size( 'false-height', $width, 100, true, false );
 
                 $file = DIR_TESTDATA . '/images/waffles.jpg';
                 $id   = $this->_make_attachment( $file, 0 );
@@ -214 +214 @@
                 $height = 202;
 
                 // Only one dimention match shouldn't return false positive (see: #17626).
-                add_image_size( 'test-size', 0, $height, false );
-                add_image_size( 'false-height', 300, $height, true );
+                add_image_size( 'test-size', 0, $height, false, false );
+                add_image_size( 'false-height', 300, $height, true, false );
 
                 $file = DIR_TESTDATA . '/images/waffles.jpg';
                 $id   = $this->_make_attachment( $file, 0 );
@@ -242 +242 @@
                 // Original is 600x400. 300x201 is close enough to match.
                 $width  = 300;
                 $height = 201;
-                add_image_size( 'off-by-one', $width, $height, true );
+                add_image_size( 'off-by-one', $width, $height, true, false );
 
                 $file = DIR_TESTDATA . '/images/waffles.jpg';
                 $id   = $this->_make_attachment( $file, 0 );
@@ -264 +264 @@
          */
         public function test_get_intermediate_size_with_small_size_array() {
                 // Add a hard cropped size that matches the aspect ratio we're going to test.
-                add_image_size( 'test-size', 200, 100, true );
+                add_image_size( 'test-size', 200, 100, true, false );
 
                 $file = DIR_TESTDATA . '/images/waffles.jpg';
                 $id   = $this->_make_attachment( $file, 0 );

tests/phpunit/tests/media.php

@@ -1142 +1142 @@
                 remove_image_size( 'test-size' );
 
                 $this->assertArrayNotHasKey( 'test-size', $_wp_additional_image_sizes );
-                add_image_size( 'test-size', 200, 600 );
+                add_image_size( 'test-size', 200, 600, false, false );
 
                 $sizes = wp_get_additional_image_sizes();
 
@@ -1154 +1154 @@
                 $this->assertSame( 600, $sizes['test-size']['height'] );
         }
 
+        /**
+         * @ticket 56288
+         */
+        public function test_add_image_size_additional_mimes() {
+                add_image_size( 'test-size-with-additional-mimes', 200, 600, false, true );
+                add_image_size( 'test-size-without-additional-mimes', 200, 600, false, false );
+
+                $sizes = wp_get_additional_image_sizes();
+
+                remove_image_size( 'test-size-with-additional-mimes' );
+                remove_image_size( 'test-size-without-additional-mimes' );
+
+                $this->assertArrayHasKey( 'test-size-with-additional-mimes', $sizes );
+                $this->assertArrayHasKey( 'test-size-without-additional-mimes', $sizes );
+                $this->assertTrue( $sizes['test-size-with-additional-mimes']['additional_mimes'] );
+                $this->assertFalse( $sizes['test-size-without-additional-mimes']['additional_mimes'] );
+        }
+
+        /**
+         * @ticket 56288
+         */
+        public function test__wp_filter_image_sizes_additional_mime_type_support_with_add_image_size() {
+                $default_sizes = wp_get_registered_image_subsizes();
+
+                add_image_size( 'test-size-with-additional-mimes', 200, 600, false, true );
+                add_image_size( 'test-size-without-additional-mimes', 200, 600, false, false );
+
+                $all_sizes      = wp_get_registered_image_subsizes();
+                $filtered_sizes = _wp_filter_image_sizes_additional_mime_type_support( $all_sizes, $this->large_id );
+
+                remove_image_size( 'test-size-with-additional-mimes' );
+                remove_image_size( 'test-size-without-additional-mimes' );
+
+                $expected_size_names   = array_keys( $default_sizes );
+                $expected_size_names[] = 'test-size-with-additional-mimes';
+
+                $this->assertSame( $expected_size_names, array_keys( $filtered_sizes ) );
+        }
+
         /**
          * @ticket 26768
          */
         public function test_remove_image_size() {
-                add_image_size( 'test-size', 200, 600 );
+                add_image_size( 'test-size', 200, 600, false, false );
                 $this->assertTrue( has_image_size( 'test-size' ) );
                 remove_image_size( 'test-size' );
                 $this->assertFalse( has_image_size( 'test-size' ) );
@@ -1168 +1207 @@
          * @ticket 26951
          */
         public function test_has_image_size() {
-                add_image_size( 'test-size', 200, 600 );
+                add_image_size( 'test-size', 200, 600, false, false );
                 $this->assertTrue( has_image_size( 'test-size' ) );
 
                 // Clean up.

tests/phpunit/tests/rest-api/rest-attachments-controller.php

@@ -710 +710 @@
                         $this->test_file
                 );
 
-                add_image_size( 'rest-api-test', 119, 119, true );
+                add_image_size( 'rest-api-test', 119, 119, true, false );
                 wp_update_attachment_metadata( $attachment_id, wp_generate_attachment_metadata( $attachment_id, $this->test_file ) );
 
                 $request            = new WP_REST_Request( 'GET', '/wp/v2/media/' . $attachment_id );
@@ -741 +741 @@
                         $this->test_file
                 );
 
-                add_image_size( 'rest-api-test', 119, 119, true );
+                add_image_size( 'rest-api-test', 119, 119, true, false );
                 wp_update_attachment_metadata( $attachment_id, wp_generate_attachment_metadata( $attachment_id, $this->test_file ) );
 
                 add_filter( 'wp_get_attachment_image_src', '__return_false' );