Changeset 63338

Timestamp:

08/21/2026 08:59:29 PM (10 hours ago)

Author:

westonruter

Message:

Media: Restore the HEIC upload error on the media upload form.

The wp_show_heic_upload_error() function assigned the heic_upload_error flag to an undeclared $plupload_init variable rather than to its $plupload_settings parameter, so the callback returned the settings untouched and the flag never reached Plupload.

Only the plupload_init path was affected: the wp_plupload_default_settings() function sets the same flag inline before applying plupload_default_settings, so screens fed by _wpPluploadSettings kept warning correctly. The regression was confined to media-new.php and the media-upload.php iframe, where media_upload_form() relies on this callback alone for HEIC.

Also correct the documented types for the settings array from array[] to array<string, mixed>, both on the function and on the plupload_init hook, and add regression tests for the callback.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/12830.
Follow-up to r48288, r58849.

Props softglaze, westonruter, khokansardar, irozum.
See #53645.
Fixes #65802.

Location:

trunk

Files:

• src/wp-admin/includes/media.php (modified) (1 diff)
• src/wp-includes/media.php (modified) (1 diff)
• tests/phpunit/tests/media.php (modified) (1 diff)

trunk/src/wp-admin/includes/media.php

@@ -2235 +2235 @@
          * @since 3.3.0
          *
-         * @param array $plupload_init An array of default settings used by Plupload.
+         * @param array<string, mixed> $plupload_init An array of default settings used by Plupload.
          */
         $plupload_init = apply_filters( 'plupload_init', $plupload_init );

trunk/src/wp-includes/media.php

@@ -5874 +5874 @@
  *              supports the format. The uploads are converted to JPEG's by default.
  *
- * @param array[] $plupload_settings The settings for Plupload.js.
- * @return array[] Modified settings for Plupload.js.
+ * @param array<string, mixed> $plupload_settings The settings for Plupload.js.
+ * @return array<string, mixed> Modified settings for Plupload.js.
  */
 function wp_show_heic_upload_error( $plupload_settings ) {
         // Check if HEIC images can be edited.
         if ( ! wp_image_editor_supports( array( 'mime_type' => 'image/heic' ) ) ) {
-                $plupload_init['heic_upload_error'] = true;
+                $plupload_settings['heic_upload_error'] = true;
         }
         return $plupload_settings;

trunk/tests/phpunit/tests/media.php

@@ -7844 +7844 @@
                 remove_filter( 'wp_editor_set_quality', $zero );
         }
+
+        /**
+         * Ensures the HEIC upload error flag is added when image editors do not support HEIC.
+         *
+         * @ticket 65802
+         *
+         * @covers ::wp_show_heic_upload_error
+         */
+        public function test_wp_show_heic_upload_error_adds_flag_when_not_supported() {
+                // Force the editor check to return false.
+                add_filter( 'wp_image_editors', '__return_empty_array' );
+
+                $settings = array( 'existing' => 'value' );
+                $result   = wp_show_heic_upload_error( $settings );
+
+                $this->assertArrayHasKey( 'heic_upload_error', $result, 'The heic_upload_error key is expected to be added to the array.' );
+                $this->assertTrue( $result['heic_upload_error'], 'The heic_upload_error flag is expected to be true.' );
+                $this->assertArrayHasKey( 'existing', $result, 'Existing array keys are expected to be preserved.' );
+                $this->assertSame( 'value', $result['existing'], 'Existing array values are expected to remain unmodified.' );
+        }
+
+        /**
+         * Ensures the HEIC upload error flag is absent when image editors support HEIC.
+         *
+         * @ticket 65802
+         *
+         * @covers ::wp_show_heic_upload_error
+         */
+        public function test_wp_show_heic_upload_error_omits_flag_when_supported() {
+                // Skip if the environment cannot support HEIC.
+                if ( ! wp_image_editor_supports( array( 'mime_type' => 'image/heic' ) ) ) {
+                        $this->markTestSkipped( 'HEIC is not supported by the selected image editor.' );
+                }
+
+                $settings = array( 'existing' => 'value' );
+                $result   = wp_show_heic_upload_error( $settings );
+
+                $this->assertArrayNotHasKey( 'heic_upload_error', $result, 'The heic_upload_error key is not expected to be present when HEIC is supported.' );
+                $this->assertArrayHasKey( 'existing', $result, 'Existing array keys are expected to be preserved.' );
+                $this->assertSame( 'value', $result['existing'], 'Existing array values are expected to remain unmodified.' );
+        }
 }