Changeset 50838

Timestamp:

05/11/2021 04:26:28 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Editor: Some documentation and test improvements for loading separate assets for core blocks:

• Move should_load_separate_core_block_assets() to a more appropriate place.
• Update DocBlocks and inline comments per the documentation standards.
• Document the $wp_styles global in wp_maybe_inline_styles().
• List the expected result first in unit test assertions.
• Remove a duplicate unit test.
• Add missing @covers tags.

Follow-up to [50836], [50837].

See #50328, #52620, #53180.

Location:

trunk

Files:

• src/wp-includes/script-loader.php (modified) (7 diffs)
• tests/phpunit/tests/blocks/register.php (modified) (2 diffs)
• tests/phpunit/tests/dependencies/styles.php (modified) (2 diffs)

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

@@ -1366 +1366 @@
 
 /**
- * Checks whether separate assets should be loaded for core blocks.
- *
- * @since 5.8
- *
- * @return bool
- */
-function should_load_separate_core_block_assets() {
-        if ( is_admin() || is_feed() || ( defined( 'REST_REQUEST' ) && REST_REQUEST ) ) {
-                return false;
-        }
-        /**
-         * Determine if separate styles & scripts will be loaded for blocks on-render or not.
-         *
-         * @since 5.8.0
-         *
-         * @param bool $load_separate_styles Whether separate styles will be loaded or not.
-         *
-         * @return bool Whether separate styles will be loaded or not.
-         */
-        return apply_filters( 'separate_core_block_assets', false );
-}
-
-/**
  * Assign default styles to $styles object.
  *
@@ -2277 +2254 @@
  * @since 5.6.0
  *
- * @return bool
+ * @return bool Whether scripts and styles should be enqueued.
  */
 function wp_should_load_block_editor_scripts_and_styles() {
@@ -2285 +2262 @@
 
         /**
-         * Filters the flag that decides whether or not block editor scripts and
-         * styles are going to be enqueued on the current screen.
+         * 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
@@ -2293 +2270 @@
          */
         return apply_filters( 'should_load_block_editor_scripts_and_styles', $is_block_editor_screen );
+}
+
+/**
+ * Checks whether separate assets should be loaded for core blocks on-render.
+ *
+ * @since 5.8.0
+ *
+ * @return bool Whether separate assets will be loaded or not.
+ */
+function should_load_separate_core_block_assets() {
+        if ( is_admin() || is_feed() || ( defined( 'REST_REQUEST' ) && REST_REQUEST ) ) {
+                return false;
+        }
+
+        /**
+         * Filters the flag that decides whether or not separate scripts and styles
+         * will be loaded for core blocks on-render or not.
+         *
+         * @since 5.8.0
+         *
+         * @param bool $load_separate_assets Whether separate assets will be loaded or not.
+         *                                   Default false.
+         */
+        return apply_filters( 'separate_core_block_assets', false );
 }
 
@@ -2530 +2531 @@
 
 /**
- * Allow small styles to be inlined.
- * This improves performance and sustainability, and is opt-in.
- *
- * Stylesheets can opt-in by adding `path` data using `wp_style_add_data`, and defining the file's absolute path.
- * wp_style_add_data( $style_handle, 'path', $file_path );
+ * Allows small styles to be inlined.
+ *
+ * This improves performance and sustainability, and is opt-in. Stylesheets can opt in
+ * by adding `path` data using `wp_style_add_data`, and defining the file's absolute path:
+ *
+ *     wp_style_add_data( $style_handle, 'path', $file_path );
  *
  * @since 5.8.0
  *
- * @return void
+ * @global WP_Styles $wp_styles
  */
 function wp_maybe_inline_styles() {
+        global $wp_styles;
 
         $total_inline_limit = 20000;
@@ -2547 +2550 @@
          *
          * @param int $total_inline_limit The file-size threshold, in bytes. Defaults to 20000.
-         * @return int                    The file-size threshold, in bytes.
          */
         $total_inline_limit = apply_filters( 'styles_inline_size_limit', $total_inline_limit );
 
-        global $wp_styles;
         $styles = array();
 
@@ -2574 +2575 @@
                 );
 
-                /**
+                /*
                  * The total inlined size.
                  *

trunk/tests/phpunit/tests/blocks/register.php

@@ -260 +260 @@
         /**
          * @ticket 50263
+         * @ticket 50328
          */
         function test_success_register_block_style_handle() {
@@ -308 +309 @@
          *
          * @ticket 50263
+         * @ticket 50328
          */
         function test_block_registers_with_metadata_fixture() {

trunk/tests/phpunit/tests/dependencies/styles.php

@@ -423 +423 @@
 
         /**
-         * Tests that the main "style.css" file gets enqueued when the site doesn't opt-in to separate_core_block_assets.
+         * Tests that the main "style.css" file gets enqueued when the site doesn't opt in to separate core block assets.
          *
          * @ticket 50263
-         */
-        function test_common_block_styles_for_viewing_without_split_styles() {
+         *
+         * @covers ::wp_default_styles
+         */
+        function test_block_styles_for_viewing_without_split_styles() {
                 add_filter( 'separate_core_block_assets', '__return_false' );
                 wp_default_styles( $GLOBALS['wp_styles'] );
 
                 $this->assertSame(
-                        $GLOBALS['wp_styles']->registered['wp-block-library']->src,
-                        '/' . WPINC . '/css/dist/block-library/style.css'
+                        '/' . WPINC . '/css/dist/block-library/style.css',
+                        $GLOBALS['wp_styles']->registered['wp-block-library']->src
                 );
         }
 
         /**
-         * Tests that the "common.css" file gets enqueued when the site opts-in to separate_core_block_assets.
+         * Tests that the "common.css" file gets enqueued when the site opts in to separate core block assets.
          *
          * @ticket 50263
-         */
-        function test_common_block_styles_for_viewing_with_split_styles() {
-                add_filter( 'separate_core_block_assets', '__return_false' );
-                wp_default_styles( $GLOBALS['wp_styles'] );
-
-                $this->assertSame(
-                        $GLOBALS['wp_styles']->registered['wp-block-library']->src,
-                        '/' . WPINC . '/css/dist/block-library/style.css'
-                );
-        }
-
+         *
+         * @covers ::wp_default_styles
+         */
         function test_block_styles_for_viewing_with_split_styles() {
                 add_filter( 'separate_core_block_assets', '__return_true' );
@@ -457 +451 @@
 
                 $this->assertSame(
-                        $GLOBALS['wp_styles']->registered['wp-block-library']->src,
-                        '/' . WPINC . '/css/dist/block-library/common.css'
+                        '/' . WPINC . '/css/dist/block-library/common.css',
+                        $GLOBALS['wp_styles']->registered['wp-block-library']->src
                 );
         }