Changeset 56382

Timestamp:

08/10/2023 04:47:00 PM (16 months ago)

Author:

flixos90

Message:

Editor: Simplify usage of block_has_support() function by supporting a string.

Most block feature checks are for a single feature string, and for such cases it is not intuitive to require an array for the $feature parameter of the block_has_support() function.

This changeset brings it in line with other functions like post_type_supports(), allowing to pass a string for the $feature. An array is still supported for more complex cases where support for sub-features needs to be determined. This change furthermore includes a very minor performance tweak by avoiding calls to the _wp_array_get() function if a single feature string is being checked for.

Props thekt12, nihar007, mukesh27, swissspidy.
Fixes #58532.

Location:

trunk

Files:

• src/wp-includes/block-supports/align.php (modified) (2 diffs)
• src/wp-includes/block-supports/border.php (modified) (1 diff)
• src/wp-includes/block-supports/custom-classname.php (modified) (2 diffs)
• src/wp-includes/block-supports/dimensions.php (modified) (1 diff)
• src/wp-includes/block-supports/generated-classname.php (modified) (1 diff)
• src/wp-includes/block-supports/layout.php (modified) (2 diffs)
• src/wp-includes/block-supports/position.php (modified) (2 diffs)
• src/wp-includes/block-supports/settings.php (modified) (2 diffs)
• src/wp-includes/block-supports/shadow.php (modified) (2 diffs)
• src/wp-includes/block-supports/spacing.php (modified) (1 diff)
• src/wp-includes/blocks.php (modified) (2 diffs)
• src/wp-includes/class-wp-theme-json.php (modified) (1 diff)
• tests/phpunit/tests/blocks/wpBlock.php (modified) (1 diff)

trunk/src/wp-includes/block-supports/align.php

@@ -16 +16 @@
  */
 function wp_register_alignment_support( $block_type ) {
-    $has_align_support = block_has_support( $block_type, array( 'align' ), false );
+    $has_align_support = block_has_support( $block_type, 'align', false );
     if ( $has_align_support ) {
         if ( ! $block_type->attributes ) {
@@ -44 +44 @@
 function wp_apply_alignment_support( $block_type, $block_attributes ) {
     $attributes        = array();
-    $has_align_support = block_has_support( $block_type, array( 'align' ), false );
+    $has_align_support = block_has_support( $block_type, 'align', false );
     if ( $has_align_support ) {
         $has_block_alignment = array_key_exists( 'align', $block_attributes );

trunk/src/wp-includes/block-supports/border.php

@@ -23 +23 @@
     }
 
-    if ( block_has_support( $block_type, array( '__experimentalBorder' ) ) && ! array_key_exists( 'style', $block_type->attributes ) ) {
+    if ( block_has_support( $block_type, '__experimentalBorder' ) && ! array_key_exists( 'style', $block_type->attributes ) ) {
         $block_type->attributes['style'] = array(
             'type' => 'object',

trunk/src/wp-includes/block-supports/custom-classname.php

@@ -16 +16 @@
  */
 function wp_register_custom_classname_support( $block_type ) {
-    $has_custom_classname_support = block_has_support( $block_type, array( 'customClassName' ), true );
+    $has_custom_classname_support = block_has_support( $block_type, 'customClassName', true );
 
     if ( $has_custom_classname_support ) {
@@ -43 +43 @@
  */
 function wp_apply_custom_classname_support( $block_type, $block_attributes ) {
-    $has_custom_classname_support = block_has_support( $block_type, array( 'customClassName' ), true );
+    $has_custom_classname_support = block_has_support( $block_type, 'customClassName', true );
     $attributes                   = array();
     if ( $has_custom_classname_support ) {

trunk/src/wp-includes/block-supports/dimensions.php

@@ -30 +30 @@
     }
 
-    $has_dimensions_support = block_has_support( $block_type, array( 'dimensions' ), false );
+    $has_dimensions_support = block_has_support( $block_type, 'dimensions', false );
 
     if ( $has_dimensions_support ) {

trunk/src/wp-includes/block-supports/generated-classname.php

@@ -51 +51 @@
 function wp_apply_generated_classname_support( $block_type ) {
     $attributes                      = array();
-    $has_generated_classname_support = block_has_support( $block_type, array( 'className' ), true );
+    $has_generated_classname_support = block_has_support( $block_type, 'className', true );
     if ( $has_generated_classname_support ) {
         $block_classname = wp_get_block_default_classname( $block_type->name );

trunk/src/wp-includes/block-supports/layout.php

@@ -203 +203 @@
  */
 function wp_register_layout_support( $block_type ) {
-    $support_layout = block_has_support( $block_type, array( 'layout' ), false ) || block_has_support( $block_type, array( '__experimentalLayout' ), false );
+    $support_layout = block_has_support( $block_type, 'layout', false ) || block_has_support( $block_type, '__experimentalLayout', false );
     if ( $support_layout ) {
         if ( ! $block_type->attributes ) {
@@ -549 +549 @@
 function wp_render_layout_support_flag( $block_content, $block ) {
     $block_type       = WP_Block_Type_Registry::get_instance()->get_registered( $block['blockName'] );
-    $support_layout   = block_has_support( $block_type, array( 'layout' ), false ) || block_has_support( $block_type, array( '__experimentalLayout' ), false );
+    $support_layout   = block_has_support( $block_type, 'layout', false ) || block_has_support( $block_type, '__experimentalLayout', false );
     $has_child_layout = isset( $block['attrs']['style']['layout']['selfStretch'] );
 

trunk/src/wp-includes/block-supports/position.php

@@ -16 +16 @@
  */
 function wp_register_position_support( $block_type ) {
-    $has_position_support = block_has_support( $block_type, array( 'position' ), false );
+    $has_position_support = block_has_support( $block_type, 'position', false );
 
     // Set up attributes and styles within that if needed.
@@ -42 +42 @@
 function wp_render_position_support( $block_content, $block ) {
     $block_type           = WP_Block_Type_Registry::get_instance()->get_registered( $block['blockName'] );
-    $has_position_support = block_has_support( $block_type, array( 'position' ), false );
+    $has_position_support = block_has_support( $block_type, 'position', false );
 
     if (

trunk/src/wp-includes/block-supports/settings.php

@@ -41 +41 @@
     // return early if the block doesn't have support for settings.
     $block_type = WP_Block_Type_Registry::get_instance()->get_registered( $block['blockName'] );
-    if ( ! block_has_support( $block_type, array( '__experimentalSettings' ), false ) ) {
+    if ( ! block_has_support( $block_type, '__experimentalSettings', false ) ) {
         return $block_content;
     }
@@ -78 +78 @@
     // Return early if the block has not support for descendent block styles.
     $block_type = WP_Block_Type_Registry::get_instance()->get_registered( $block['blockName'] );
-    if ( ! block_has_support( $block_type, array( '__experimentalSettings' ), false ) ) {
+    if ( ! block_has_support( $block_type, '__experimentalSettings', false ) ) {
         return null;
     }

trunk/src/wp-includes/block-supports/shadow.php

@@ -16 +16 @@
  */
 function wp_register_shadow_support( $block_type ) {
-    $has_shadow_support = block_has_support( $block_type, array( 'shadow' ), false );
+    $has_shadow_support = block_has_support( $block_type, 'shadow', false );
 
     if ( ! $has_shadow_support ) {
@@ -51 +51 @@
  */
 function wp_apply_shadow_support( $block_type, $block_attributes ) {
-    $has_shadow_support = block_has_support( $block_type, array( 'shadow' ), false );
+    $has_shadow_support = block_has_support( $block_type, 'shadow', false );
 
     if ( ! $has_shadow_support ) {

trunk/src/wp-includes/block-supports/spacing.php

@@ -19 +19 @@
  */
 function wp_register_spacing_support( $block_type ) {
-    $has_spacing_support = block_has_support( $block_type, array( 'spacing' ), false );
+    $has_spacing_support = block_has_support( $block_type, 'spacing', false );
 
     // Setup attributes and styles within that if needed.

trunk/src/wp-includes/blocks.php

@@ -1249 +1249 @@
  *
  * @since 5.8.0
+ * @since 6.4.0 The `$feature` parameter now supports a string.
  *
  * @param WP_Block_Type $block_type    Block type to check for support.
- * @param array         $feature       Path to a specific feature to check support for.
+ * @param string|array  $feature       Feature slug, or path to a specific feature to check support for.
  * @param mixed         $default_value Optional. Fallback value for feature support. Default false.
  * @return bool Whether the feature is supported.
@@ -1258 +1259 @@
     $block_support = $default_value;
     if ( $block_type && property_exists( $block_type, 'supports' ) ) {
-        $block_support = _wp_array_get( $block_type->supports, $feature, $default_value );
+        if ( is_array( $feature ) && count( $feature ) === 1 ) {
+            $feature = $feature[0];
+        }
+
+        if ( is_array( $feature ) ) {
+            $block_support = _wp_array_get( $block_type->supports, $feature, $default_value );
+        } elseif ( isset( $block_type->supports[ $feature ] ) ) {
+            $block_support = $block_type->supports[ $feature ];
+        }
     }
 

trunk/src/wp-includes/class-wp-theme-json.php

@@ -1264 +1264 @@
         if ( isset( $block_metadata['name'] ) ) {
             $block_type = WP_Block_Type_Registry::get_instance()->get_registered( $block_metadata['name'] );
-            if ( ! block_has_support( $block_type, array( 'layout' ), false ) && ! block_has_support( $block_type, array( '__experimentalLayout' ), false ) ) {
+            if ( ! block_has_support( $block_type, 'layout', false ) && ! block_has_support( $block_type, '__experimentalLayout', false ) ) {
                 return $block_rules;
             }

trunk/tests/phpunit/tests/blocks/wpBlock.php

@@ -684 +684 @@
 
     /**
+     * @ticket 58532
+     *
+     * @dataProvider data_block_has_support_string
+     *
+     * @param array  $block_data Block data.
+     * @param string $support    Support string to check.
+     * @param bool   $expected   Expected result.
+     */
+    public function test_block_has_support_string( $block_data, $support, $expected, $message ) {
+        $this->registry->register( 'core/example', $block_data );
+        $block_type  = $this->registry->get_registered( 'core/example' );
+        $has_support = block_has_support( $block_type, $support );
+        $this->assertEquals( $expected, $has_support, $message );
+    }
+
+    /**
+     * Data provider for test_block_has_support_string
+     */
+    public function data_block_has_support_string() {
+        return array(
+            array(
+                array(),
+                'color',
+                false,
+                'Block with empty support array.',
+            ),
+            array(
+                array(
+                    'supports' => array(
+                        'align'    => array( 'wide', 'full' ),
+                        'fontSize' => true,
+                        'color'    => array(
+                            'link'     => true,
+                            'gradient' => false,
+                        ),
+                    ),
+                ),
+                'align',
+                true,
+                'Feature present in support array.',
+            ),
+            array(
+                array(
+                    'supports' => array(
+                        'align'    => array( 'wide', 'full' ),
+                        'fontSize' => true,
+                        'color'    => array(
+                            'link'     => true,
+                            'gradient' => false,
+                        ),
+                    ),
+                ),
+                'anchor',
+                false,
+                'Feature not present in support array.',
+            ),
+            array(
+                array(
+                    'supports' => array(
+                        'align'    => array( 'wide', 'full' ),
+                        'fontSize' => true,
+                        'color'    => array(
+                            'link'     => true,
+                            'gradient' => false,
+                        ),
+                    ),
+                ),
+                array( 'align' ),
+                true,
+                'Feature present in support array, single element array.',
+            ),
+        );
+    }
+
+    /**
      * @ticket 51612
      */