Changeset 64827

Timestamp:

10/27/2026 07:40:03 PM (4 days ago)

Author:

lancewillett

Message:

Tests: Cover sidebar REST response preparation.

Replace the assertion-free sidebar preparation test with checks for response data and links. Verify that links are omitted when _fields excludes them.

Developed in: ​https://github.com/WordPress/wordpress-develop/pull/14695

Props devmuhib, shailu25, huzaifaalmesbah.
See #40538.

File:

• trunk/tests/phpunit/tests/rest-api/rest-sidebars-controller.php (modified) (1 diff)

trunk/tests/phpunit/tests/rest-api/rest-sidebars-controller.php

@@ -1138 +1138 @@
 
         /**
-         * The prepare_item() method does not exist for sidebar.
+         * @ticket 40538
          *
-         * @doesNotPerformAssertions
+         * @covers WP_REST_Sidebars_Controller::prepare_item_for_response
          */
         public function test_prepare_item() {
-                // Controller does not implement prepare_item().
+                $this->setup_sidebar(
+                        'sidebar-1',
+                        array(
+                                'name'        => 'Test sidebar',
+                                'description' => 'Test description',
+                        )
+                );
+
+                $raw_sidebar = array(
+                        'id'   => 'sidebar-1',
+                        'name' => 'Test sidebar',
+                );
+
+                $controller = new WP_REST_Sidebars_Controller();
+                $request    = new WP_REST_Request( 'GET', '/wp/v2/sidebars/sidebar-1' );
+                $response   = $controller->prepare_item_for_response( $raw_sidebar, $request );
+
+                $this->assertInstanceOf( WP_REST_Response::class, $response );
+                $this->assertSame( 200, $response->get_status() );
+
+                $data = $response->get_data();
+                $this->assertSame( 'sidebar-1', $data['id'] );
+                $this->assertSame( 'Test sidebar', $data['name'] );
+                $this->assertSame( 'Test description', $data['description'] );
+                $this->assertSame( 'active', $data['status'] );
+                $this->assertSame( array(), $data['widgets'] );
+
+                $links = $response->get_links();
+                $this->assertArrayHasKey( 'self', $links );
+                $this->assertSame( rest_url( 'wp/v2/sidebars/sidebar-1' ), $links['self'][0]['href'] );
+                $this->assertArrayHasKey( 'collection', $links );
+                $this->assertSame( rest_url( 'wp/v2/sidebars' ), $links['collection'][0]['href'] );
+        }
+
+        /**
+         * @ticket 40538
+         *
+         * @covers WP_REST_Sidebars_Controller::prepare_item_for_response
+         */
+        public function test_prepare_item_limit_fields() {
+                $this->setup_sidebar(
+                        'sidebar-1',
+                        array(
+                                'name' => 'Test sidebar',
+                        )
+                );
+
+                $raw_sidebar = array(
+                        'id'   => 'sidebar-1',
+                        'name' => 'Test sidebar',
+                );
+
+                $controller = new WP_REST_Sidebars_Controller();
+                $request    = new WP_REST_Request( 'GET', '/wp/v2/sidebars/sidebar-1' );
+                $request->set_param( '_fields', 'id,name' );
+
+                $response = $controller->prepare_item_for_response( $raw_sidebar, $request );
+
+                $this->assertEmpty( $response->get_links(), 'Links should be omitted when _links is not in _fields.' );
         }