Changeset 52312

Timestamp:

12/03/2021 03:28:21 PM (5 years ago)

Author:

audrasjb

Message:

Editor: Avoid undefined index notices in the Template Parts Editor.

This changes adds a leading slash when needed in the ?context=edit path to avoid an undefined index notice in the Template Parts Editor.

Follow-up to [52275].

Props kafleg, costdev, mukesh27, Boniu91.
Fixes #54558.

Location:

trunk

Files:

• src/wp-includes/block-editor.php (modified) (1 diff)
• tests/phpunit/tests/blocks/editor.php (modified) (1 diff)

trunk/src/wp-includes/block-editor.php

@@ -468 +468 @@
          */
         $backup_global_post = ! empty( $post ) ? clone $post : $post;
+
+        foreach ( $preload_paths as &$path ) {
+                if ( is_string( $path ) && ! str_starts_with( $path, '/' ) ) {
+                        $path = '/' . $path;
+                        continue;
+                }
+
+                if ( is_array( $path ) && is_string( $path[0] ) && ! str_starts_with( $path[0], '/' ) ) {
+                                $path[0] = '/' . $path[0];
+                }
+        }
 
         $preload_data = array_reduce(

trunk/tests/phpunit/tests/blocks/editor.php

@@ -494 +494 @@
                 $this->assertStringContainsString( '"\/wp\/v2\/types"', $after );
         }
+
+        /**
+         * @ticket 54558
+         * @dataProvider data_block_editor_rest_api_preload_adds_missing_leading_slash
+         *
+         * @covers ::block_editor_rest_api_preload
+         *
+         * @param array  $preload_paths The paths to preload.
+         * @param string $expected      The expected substring.
+         */
+        public function test_block_editor_rest_api_preload_adds_missing_leading_slash( array $preload_paths, $expected ) {
+                block_editor_rest_api_preload( $preload_paths, new WP_Block_Editor_Context() );
+                $haystack = implode( '', wp_scripts()->registered['wp-api-fetch']->extra['after'] );
+                $this->assertStringContainsString( $expected, $haystack );
+        }
+
+        /**
+         * Data provider.
+         *
+         * @return array
+         */
+        public function data_block_editor_rest_api_preload_adds_missing_leading_slash() {
+                return array(
+                        'a string without a slash' => array(
+                                'preload_paths' => array( 'wp/v2/blocks' ),
+                                'expected'      => '\/wp\/v2\/blocks',
+                        ),
+                        'a string with a slash' => array(
+                                'preload_paths' => array( '/wp/v2/blocks' ),
+                                'expected'      => '\/wp\/v2\/blocks',
+                        ),
+                        'a string starting with a question mark' => array(
+                                'preload_paths' => array( '?context=edit' ),
+                                'expected'      => '/?context=edit',
+                        ),
+                        'an array with a string without a slash' => array(
+                                'preload_paths' => array( array( 'wp/v2/blocks', 'OPTIONS' ) ),
+                                'expected'      => '\/wp\/v2\/blocks',
+                        ),
+                        'an array with a string with a slash' => array(
+                                'preload_paths' => array( array( '/wp/v2/blocks', 'OPTIONS' ) ),
+                                'expected'      => '\/wp\/v2\/blocks',
+                        ),
+                        'an array with a string starting with a question mark' => array(
+                                'preload_paths' => array( array( '?context=edit', 'OPTIONS' ) ),
+                                'expected'      => '\/?context=edit',
+                        ),
+                );
+        }
 }