Return empty taxonomy collections as JSON object, not array

kadamwhite · kadamwhite · commit 185608ff086d · 2016-10-16T14:26:05.000-04:00
The response from `/wp/v2/taxonomies` is a JSON object, keyed with the name of each taxonomy. If you use the `?type=` query parameter to specify an object for which no taxonomies are available, or to specify an invalid type of object, the empty PHP `array()` will be rendered in JSON as `[]`. To ensure that the type of this resource's response remains consistent this pull request casts empty arrays to a PHP object, which will be correctly rendered as `{}` in the response JSON. Fixes #2803
diff --git a/lib/endpoints/class-wp-rest-taxonomies-controller.php b/lib/endpoints/class-wp-rest-taxonomies-controller.php
@@ -83,6 +83,12 @@ public function get_items( $request ) {
 			$tax = $this->prepare_response_for_collection( $tax );
 			$data[ $tax_type ] = $tax;
 		}
+
+		if ( empty( $data ) ) {
+			// Response should still be returned as a JSON object when it is empty.
+			$data = (object) $data;
+		}
+
 		return rest_ensure_response( $data );
 	}
 
diff --git a/tests/test-rest-taxonomies-controller.php b/tests/test-rest-taxonomies-controller.php
@@ -46,13 +46,22 @@ public function test_get_items_invalid_permission_for_context() {
 		$this->assertErrorResponse( 'rest_cannot_view', $response, 401 );
 	}
 
-	public function test_get_taxonomies_with_types() {
+	public function test_get_taxonomies_for_type() {
 		$request = new WP_REST_Request( 'GET', '/wp/v2/taxonomies' );
 		$request->set_param( 'type', 'post' );
 		$response = $this->server->dispatch( $request );
 		$this->check_taxonomies_for_type_response( 'post', $response );
 	}
 
+	public function test_get_taxonomies_for_invalid_type() {
+		$request = new WP_REST_Request( 'GET', '/wp/v2/taxonomies' );
+		$request->set_param( 'type', 'wingding' );
+		$response = $this->server->dispatch( $request );
+		$this->assertEquals( 200, $response->get_status() );
+		$data = $response->get_data();
+		$this->assertEquals( json_encode( $data ), '{}' );
+	}
+
 	public function test_get_item() {
 		$request = new WP_REST_Request( 'GET', '/wp/v2/taxonomies/category' );
 		$response = $this->server->dispatch( $request );

Original file line number	Diff line number	Diff line change
`@@ -83,6 +83,12 @@ public function get_items( $request ) {`
`83`	`83`	`$tax = $this->prepare_response_for_collection( $tax );`
`84`	`84`	`$data[ $tax_type ] = $tax;`
`85`	`85`	`}`
	`86`	`+`
	`87`	`+ if ( empty( $data ) ) {`
	`88`	`+ // Response should still be returned as a JSON object when it is empty.`
	`89`	`+ $data = (object) $data;`
	`90`	`+ }`
	`91`	`+`
`86`	`92`	`return rest_ensure_response( $data );`
`87`	`93`	`}`
`88`	`94`