Changeset 40137

Timestamp:

02/27/2017 08:02:43 PM (8 years ago)

Author:

ocean90

Message:

REST API: Allow setting post formats even if they are not supported by the theme.

A post_format not used by the current theme, but supported by core is not a wrong/broken piece of information. It's just not used at this point in time. Therefore we should allow setting and retrieving any of the standard post formats supported in core, even if the current theme doesn't use them.

After this commit, a post's format value can survive a round trip through the API, which is a good general design principle for an API.

Merge of [40120] and [40121] to the 4.7 branch.

Props JPry, iseulde, davidakennedy, Drivingralle.
Fixes #39232.

Location:

branches/4.7

Files:

• . (modified) (1 prop)
• src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-posts-controller.php (modified) (3 diffs)
• tests/qunit/fixtures/wp-api-generated.js (modified) (2 diffs)

branches/4.7/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

@@ -1984 +1984 @@
 
                 case 'post-formats':
-                    $supports_formats = get_theme_support( 'post-formats' );
-
-                    // Force to an array. Supports formats can return true even if empty in some cases.
-                    $supports_formats = is_array( $supports_formats ) ? array_values( $supports_formats[0] ) : array();
-
-                    $supported_formats = array_merge( array( 'standard' ), $supports_formats );
+                    // Get the native post formats and remove the array keys.
+                    $formats = array_values( get_post_format_slugs() );
 
                     $schema['properties']['format'] = array(
                         'description' => __( 'The format for the object.' ),
                         'type'        => 'string',
-                        'enum'        => $supported_formats,
+                        'enum'        => $formats,
                         'context'     => array( 'view', 'edit' ),
                     );

branches/4.7/tests/phpunit/tests/rest-api/rest-posts-controller.php

@@ -991 +991 @@
     }
 
-    public function test_get_items_no_supported_post_formats() {
-        // This causes get_theme_support( 'post-formats' ) to return `true` (not an array)
-        add_theme_support( 'post-formats' );
-
+    public function test_get_items_all_post_formats() {
         $request = new WP_REST_Request( 'OPTIONS', '/wp/v2/posts' );
         $response = $this->server->dispatch( $request );
         $data = $response->get_data();
 
-        // Set the expected state back for the rest of the tests.
-        global $_wp_theme_features;
-        unset( $_wp_theme_features['post-formats'] );
-        add_theme_support( 'post-formats', array( 'post', 'gallery' ) );
-
-        $formats = array( 'standard' );
+        $formats = array_values( get_post_format_slugs() );
 
         $this->assertEquals( $formats, $data['schema']['properties']['format']['enum'] );
@@ -1652 +1644 @@
         $request->set_body_params( $params );
         $response = $this->server->dispatch( $request );
-
-        $this->assertErrorResponse( 'rest_invalid_param', $response, 400 );
+        $this->assertEquals( 201, $response->get_status() );
+
+        $data = $response->get_data();
+        $this->assertEquals( 'link', $data['format'] );
     }
 
@@ -2150 +2144 @@
         $request->set_body_params( $params );
         $response = $this->server->dispatch( $request );
-
-        $this->assertErrorResponse( 'rest_invalid_param', $response, 400 );
+        $this->assertEquals( 200, $response->get_status() );
+
+        $data = $response->get_data();
+        $this->assertEquals( 'link', $data['format'] );
     }
 

branches/4.7/tests/qunit/fixtures/wp-api-generated.js

@@ -389 +389 @@
                             "required": false,
                             "enum": [
-                                "standard"
+                                "standard",
+                                "aside",
+                                "chat",
+                                "gallery",
+                                "link",
+                                "image",
+                                "quote",
+                                "status",
+                                "video",
+                                "audio"
                             ],
                             "description": "The format for the object.",
@@ -563 +572 @@
                             "required": false,
                             "enum": [
-                                "standard"
+                                "standard",
+                                "aside",
+                                "chat",
+                                "gallery",
+                                "link",
+                                "image",
+                                "quote",
+                                "status",
+                                "video",
+                                "audio"
                             ],
                             "description": "The format for the object.",