Changeset 52261

Timestamp:

11/28/2021 01:51:23 PM (8 weeks ago)

Author:

audrasjb

Message:

Editor: Ensure block style name does not contain spaces before creating the class.

This change adds a check to ensure there is no spaces in block style variation names before generating the class. Returns false and a _doing_it_wrong() message if a space is detected.

Props amustaque97, costdev, hellofromtonya, pbiron, SergeyBiryukov, afragen.
Fixes #54296.

Location:

trunk

Files:

• src/wp-includes/class-wp-block-styles-registry.php (modified) (1 diff)
• tests/phpunit/tests/blocks/register.php (modified) (2 diffs)

trunk/src/wp-includes/class-wp-block-styles-registry.php

@@ -59 +59 @@
                 __( 'Block style name must be a string.' ),
                 '5.3.0'
+            );
+            return false;
+        }
+
+        if ( str_contains( $style_properties['name'], ' ' ) ) {
+            _doing_it_wrong(
+                __METHOD__,
+                __( 'Block style name must not contain any spaces.' ),
+                '5.9.0'
             );
             return false;

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

@@ -9 +9 @@
 
 /**
- * Tests for register_block_type(), unregister_block_type(), get_dynamic_block_names().
+ * Tests for register_block_type(), unregister_block_type(), get_dynamic_block_names() and register_block_style().
  *
  * @since 5.0.0
@@ -560 +560 @@
         $this->assertSame( 3, $result->api_version );
     }
+
+    /**
+     * Test case to validate `_doing_it_wrong()` when block style name attribute
+     * contains one or more spaces.
+     *
+     * @dataProvider data_register_block_style_name_contain_spaces
+     *
+     * @ticket 54296
+     *
+     * @covers ::register_block_style
+     *
+     * @expectedIncorrectUsage WP_Block_Styles_Registry::register
+     * @param array $block_styles Array of block styles to test.
+     */
+    public function test_register_block_style_name_contain_spaces( array $block_styles ) {
+        register_block_style( 'core/query', $block_styles );
+    }
+
+    /**
+     * Data provider.
+     *
+     * @return array
+     */
+    public function data_register_block_style_name_contain_spaces() {
+        return array(
+            'multiple spaces' => array(
+                array(
+                    'name'  => 'style-class-1    style-class-2',
+                    'label' => 'Custom Style Label',
+                ),
+            ),
+            'single space'    => array(
+                array(
+                    'name'  => 'style-class-1 style-class-2',
+                    'label' => 'Custom Style Label',
+                ),
+            ),
+        );
+    }
+
+    /**
+     * Test case to validate no `_doing_it_wrong()` happens when there is
+     * no empty space.
+     *
+     * @ticket 54296
+     *
+     * @covers ::register_block_style
+     */
+    public function test_register_block_style_name_without_spaces() {
+        $block_styles = array(
+            'name'  => 'style-class-1',
+            'label' => 'Custom Style Label',
+        );
+
+        $actual = register_block_style( 'core/query', $block_styles );
+        $this->assertTrue( $actual );
+    }
 }