Changeset 49080

Timestamp:

10/01/2020 12:37:54 AM (4 years ago)

Author:

noisysocks

Message:

Editor: Add should_load_block_editor_scripts_and_styles

Adds a new should_load_block_editor_scripts_and_styles filter which can be used
by plugins including Gutenberg to more precisely customise when block editor
scripts and styles should be loaded by script-loader.php. Previously, plugins
had to fiddle with $current_screen->is_block_editor().

Props zieladam.
See #51330.

File:

• trunk/src/wp-includes/script-loader.php (modified) (4 diffs)

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

@@ -2161 +2161 @@
  */
 function wp_common_block_scripts_and_styles() {
-    global $current_screen;
-
-    if ( is_admin() && ( $current_screen instanceof WP_Screen ) && ! $current_screen->is_block_editor() ) {
+    if ( is_admin() && ! _should_load_block_editor_scripts_and_styles() ) {
         return;
     }
@@ -2187 +2185 @@
 
 /**
+ * Checks if the editor scripts and styles for all registered block types
+ * should be enqueued on the current screen.
+ *
+ * @access private
+ *
+ * @return boolean
+ */
+function _should_load_block_editor_scripts_and_styles() {
+    global $current_screen;
+
+    $is_block_editor_screen = ( $current_screen instanceof WP_Screen ) && $current_screen->is_block_editor();
+
+    /**
+     * Filters the flag that decides whether or not block editor scripts and
+     * styles are going to be enqueued on the current screen.
+     *
+     * @since 5.6.0
+     *
+     * @param boolean $is_block_editor_screen Current value of the flag
+     */
+    return apply_filters( 'should_load_block_editor_scripts_and_styles', $is_block_editor_screen );
+}
+
+/**
  * Enqueues registered block scripts and styles, depending on current rendered
  * context (only enqueuing editor scripts while in context of the editor).
@@ -2197 +2219 @@
     global $current_screen;
 
-    $is_editor = ( ( $current_screen instanceof WP_Screen ) && $current_screen->is_block_editor() );
+    $load_editor_scripts = _should_load_block_editor_scripts_and_styles();
 
     $block_registry = WP_Block_Type_Registry::get_instance();
@@ -2212 +2234 @@
 
         // Editor styles.
-        if ( $is_editor && ! empty( $block_type->editor_style ) ) {
+        if ( $load_editor_scripts && ! empty( $block_type->editor_style ) ) {
             wp_enqueue_style( $block_type->editor_style );
         }
 
         // Editor script.
-        if ( $is_editor && ! empty( $block_type->editor_script ) ) {
+        if ( $load_editor_scripts && ! empty( $block_type->editor_script ) ) {
             wp_enqueue_script( $block_type->editor_script );
         }