Changeset 62546

Timestamp:

06/23/2026 08:26:54 AM (4 months ago)

Author:

tyxla

Message:

Editor: Hide Classic Block from inserter.

Hide the Classic block in the block editor inserter by default, since classic content is largely a legacy editing path and should not be surfaced as a primary insertion option.

Introduce a new wp_classic_block_supports_inserter filter that allows re-enabling the Classic block in the inserter, either globally or on a per-post basis.

Existing classic content (the core/freeform block) continues to render and remain editable; only its visibility in the inserter is affected.

This ports Gutenberg PR #77911 to Core.

Developed in: ​https://github.com/WordPress/wordpress-develop/pull/11712

Props desrosj, mamaduka, mukesh27, tyxla, westonruter, wildworks, yuliyan.
Fixes #65166.

Location:

trunk

Files:

• src/wp-includes/default-filters.php (modified) (1 diff)
• src/wp-includes/script-loader.php (modified) (1 diff)
• tests/phpunit/tests/dependencies/scripts.php (modified) (1 diff)

trunk/src/wp-includes/default-filters.php

@@ -645 +645 @@
 add_action( 'enqueue_block_editor_assets', 'wp_enqueue_global_styles_css_custom_properties' );
 add_action( 'enqueue_block_editor_assets', '_wp_enqueue_auto_register_blocks' );
+add_action( 'enqueue_block_editor_assets', 'wp_declare_classic_block_necessary' );
 add_action( 'wp_print_scripts', 'wp_just_in_time_script_localization' );
 add_filter( 'print_scripts_array', 'wp_prototype_before_jquery' );

trunk/src/wp-includes/script-loader.php

@@ -2648 +2648 @@
 
 /**
+ * Declares a flag that the Classic block is necessary for the current post.
+ *
+ * @since 7.1.0
+ * @access private
+ */
+function wp_declare_classic_block_necessary(): void {
+        /**
+         * Filters whether the Classic block should be available in the inserter.
+         *
+         * Defaults to false. Use this filter to opt in (globally or per post).
+         *
+         * @param bool         $supports_inserter Whether the Classic block is available in the inserter.
+         * @param WP_Post|null $post              The post being edited, or null if not in the post editor.
+         */
+        if ( ! (bool) apply_filters( 'wp_classic_block_supports_inserter', false, get_post() ) ) {
+                return;
+        }
+
+        wp_add_inline_script(
+                'wp-block-library',
+                'window.__needsClassicBlock = true;',
+                'before'
+        );
+}
+
+/**
  * Checks if the editor scripts and styles for all registered block types
  * should be enqueued on the current screen.

trunk/tests/phpunit/tests/dependencies/scripts.php

@@ -4544 +4544 @@
 
         /**
+         * Tests that the Classic block is hidden from the inserter by default.
+         *
+         * @ticket 65166
+         *
+         * @covers ::wp_declare_classic_block_necessary
+         */
+        public function test_wp_declare_classic_block_necessary_does_nothing_by_default() {
+                wp_register_script( 'wp-block-library', 'https://example.org/wp-block-library.js' );
+
+                wp_declare_classic_block_necessary();
+
+                $this->assertFalse(
+                        wp_scripts()->get_data( 'wp-block-library', 'before' ),
+                        'No inline script should be enqueued when the filter is not used.'
+                );
+        }
+
+        /**
+         * Tests that the Classic block can be opted into the inserter via the filter.
+         *
+         * @ticket 65166
+         *
+         * @covers ::wp_declare_classic_block_necessary
+         */
+        public function test_wp_declare_classic_block_necessary_enqueues_flag_when_filter_enabled() {
+                wp_register_script( 'wp-block-library', 'https://example.org/wp-block-library.js' );
+                add_filter( 'wp_classic_block_supports_inserter', '__return_true' );
+
+                wp_declare_classic_block_necessary();
+
+                $before = wp_scripts()->get_data( 'wp-block-library', 'before' );
+                $this->assertIsArray(
+                        $before,
+                        'An inline script should be enqueued when the filter opts in.'
+                );
+                $this->assertContains(
+                        'window.__needsClassicBlock = true;',
+                        $before,
+                        'The Classic block flag should be added to the wp-block-library inline scripts.'
+                );
+        }
+
+        /**
+         * Tests that the current post is passed to the filter.
+         *
+         * @ticket 65166
+         *
+         * @covers ::wp_declare_classic_block_necessary
+         */
+        public function test_wp_declare_classic_block_necessary_passes_post_to_filter() {
+                wp_register_script( 'wp-block-library', 'https://example.org/wp-block-library.js' );
+
+                $post_id         = self::factory()->post->create();
+                $GLOBALS['post'] = get_post( $post_id );
+
+                $filter_post = false;
+                add_filter(
+                        'wp_classic_block_supports_inserter',
+                        static function ( $supports_inserter, $post ) use ( &$filter_post ) {
+                                $filter_post = $post;
+                                return $supports_inserter;
+                        },
+                        10,
+                        2
+                );
+
+                wp_declare_classic_block_necessary();
+
+                $this->assertInstanceOf( WP_Post::class, $filter_post, 'The post should be passed to the filter.' );
+                $this->assertSame( $post_id, $filter_post->ID, 'The current post should be passed to the filter.' );
+        }
+
+        /**
          * Normalizes markup for snapshot.
          *