Changeset 54772

Timestamp:

11/09/2022 01:06:46 AM (4 years ago)

Author:

flixos90

Message:

Editor: Improve frontend performance for get_default_block_editor_settings().

The wp_max_upload_size() function can be expensive to call, especially for large sites or multisites. For the frontend usage of get_default_block_editor_settings() knowing the allowed upload size is typically unnecessary.

This changeset adds a condition so that wp_max_upload_size() is only called if the current user can actually upload_files. It keeps the data present when it is actually needed while avoiding the execution overhead when it is not needed.

Props janthiel, Clorith, flixos90, spacedmonkey.
Merges [54769] to the 6.1 branch.
Fixes #56815.

Location:

branches/6.1

Files:

• . (modified) (1 prop)
• src/wp-includes/block-editor.php (modified) (1 diff)
• tests/phpunit/tests/blocks/editor.php (modified) (1 diff)

branches/6.1/src/wp-includes/block-editor.php

@@ -154 +154 @@
 function get_default_block_editor_settings() {
         // Media settings.
-        $max_upload_size = wp_max_upload_size();
-        if ( ! $max_upload_size ) {
-                $max_upload_size = 0;
+
+        // wp_max_upload_size() can be expensive, so only call it when relevant for the current user.
+        $max_upload_size = 0;
+        if ( current_user_can( 'upload_files' ) ) {
+                $max_upload_size = wp_max_upload_size();
+                if ( ! $max_upload_size ) {
+                        $max_upload_size = 0;
+                }
         }
 

branches/6.1/tests/phpunit/tests/blocks/editor.php

@@ -300 +300 @@
                 $this->assertIsInt( $settings['maxUploadFileSize'] );
                 $this->assertTrue( $settings['__unstableGalleryWithImageBlocks'] );
+        }
+
+        /**
+         * @ticket 56815
+         */
+        public function test_get_default_block_editor_settings_max_upload_file_size() {
+                // Force the return value of wp_max_upload_size() to be 500.
+                add_filter(
+                        'upload_size_limit',
+                        function() {
+                                return 500;
+                        }
+                );
+
+                // Expect 0 when user is not allowed to upload (as wp_max_upload_size() should not be called).
+                $settings = get_default_block_editor_settings();
+                $this->assertSame( 0, $settings['maxUploadFileSize'] );
+
+                // Set up an administrator, as they can upload files.
+                $administrator = self::factory()->user->create( array( 'role' => 'administrator' ) );
+                wp_set_current_user( $administrator );
+
+                // Expect the above 500 as the user is now allowed to upload.
+                $settings = get_default_block_editor_settings();
+                $this->assertSame( 500, $settings['maxUploadFileSize'] );
         }