Changeset 62973

Timestamp:

08/03/2026 02:20:36 PM (15 hours ago)

Author:

oandregal

Message:

View config REST Endpoint: remove search and page.

The search and page parameters source of truth is the URL,
and cannot be configured via the filters.

Props oandregal, ntsekouras, jorgefilipecosta.
Fixes #65577.

Location:

trunk

Files:

• src/wp-includes/class-wp-view-config-data.php (modified) (2 diffs)
• src/wp-includes/rest-api/endpoints/class-wp-rest-view-config-controller.php (modified) (3 diffs)
• tests/phpunit/tests/rest-api/rest-view-config-controller.php (modified) (1 diff)

trunk/src/wp-includes/class-wp-view-config-data.php

@@ -356 +356 @@
          * ```php
          * array(
-         *   'default_view' => array( 'search' => 'new search', 'fields' => array( 'newField' ) ),
+         *   'default_view' => array( 'titleField' => 'newTitleField', 'fields' => array( 'newField' ) ),
          *   'default_layouts' => array( 'grid' => array( 'layout' => array( 'badgeFields' => array( 'newField' ) ) ) ),
          *   'view_list' => array( array( 'slug' => 'table', 'title' => 'New title' ) ),
@@ -362 +362 @@
          * ```
          *
-         * - default_view will be updated so the search string is 'new search' and the newField is appended to the list of fields.
+         * - default_view will be updated so the titleField is 'newTitleField' and the newField is appended to the list of fields.
          * - default_layouts will be updated so that newField is appended to the badgeFields.
          * - view_list will be updated so that the view with slug 'table' has its title changed to 'New title'.

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-view-config-controller.php

@@ -392 +392 @@
          * Returns the schema properties shared by all view types (ViewBase), excluding 'type'.
          *
+         * Note that `search` and `page` are not part of the schema: they are managed
+         * via the URL, which is their only source of truth.
+         *
          * @since 7.1.0
          *
@@ -398 +401 @@
         protected function get_view_base_schema() {
                 return array(
-                        'search'                => array(
-                                'type' => 'string',
-                        ),
                         'filters'               => array(
                                 'type'  => 'array',
@@ -444 +444 @@
                                         ),
                                 ),
-                        ),
-                        'page'                  => array(
-                                'type' => 'integer',
                         ),
                         'perPage'               => array(

trunk/tests/phpunit/tests/rest-api/rest-view-config-controller.php

@@ -386 +386 @@
                 );
         }
+
+        /**
+         * `search` and `page` are not part of the view schema: they are managed via
+         * the URL, which is their only source of truth.
+         *
+         * @covers ::get_item_schema
+         */
+        public function test_get_item_schema_excludes_url_managed_view_properties() {
+                $controller = new WP_REST_View_Config_Controller();
+                $schema     = $controller->get_item_schema();
+
+                $views = array(
+                        'default_view'             => $schema['properties']['default_view']['properties'],
+                        'view_list item view'      => $schema['properties']['view_list']['items']['properties']['view']['properties'],
+                        'default_layouts.table'    => $schema['properties']['default_layouts']['properties']['table']['properties'],
+                        'default_layouts.grid'     => $schema['properties']['default_layouts']['properties']['grid']['properties'],
+                        'default_layouts.list'     => $schema['properties']['default_layouts']['properties']['list']['properties'],
+                        'default_layouts.activity' => $schema['properties']['default_layouts']['properties']['activity']['properties'],
+                );
+
+                foreach ( $views as $label => $properties ) {
+                        $this->assertArrayNotHasKey( 'search', $properties, "$label should not declare a `search` property." );
+                        $this->assertArrayNotHasKey( 'page', $properties, "$label should not declare a `page` property." );
+                }
+        }
 }