Changeset 43439

Timestamp:

07/13/2018 04:06:23 AM (6 years ago)

Author:

pento

Message:

REST API: Expose revision count and last revision ID on Post response

So that REST API clients can show appropriate UI for a post's revisions, it needs to know how many revisions the post has, and what the latest revision ID is.

Props kadamwhite, danielbachhuber, birgire, TimothyBlynJacobs.
Fixes #44321.

Location:

trunk

Files:

• 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) (2 diffs)
• tests/qunit/fixtures/wp-api-generated.js (modified) (6 diffs)

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

@@ -1676 +1676 @@
 
         if ( in_array( $post->post_type, array( 'post', 'page' ), true ) || post_type_supports( $post->post_type, 'revisions' ) ) {
+            $revisions       = wp_get_post_revisions( $post->ID, array( 'fields' => 'ids' ) );
+            $revisions_count = count( $revisions );
+
             $links['version-history'] = array(
-                'href' => rest_url( trailingslashit( $base ) . $post->ID . '/revisions' ),
-            );
+                'href'  => rest_url( trailingslashit( $base ) . $post->ID . '/revisions' ),
+                'count' => $revisions_count,
+            );
+
+            if ( $revisions_count > 0 ) {
+                $last_revision = array_shift( $revisions );
+
+                $links['predecessor-version'] = array(
+                    'href' => rest_url( trailingslashit( $base ) . $post->ID . '/revisions/' . $last_revision ),
+                    'id'   => $last_revision,
+                );
+            }
+
         }
 

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

@@ -1284 +1284 @@
 
         $this->assertEquals( rest_url( '/wp/v2/posts/' . self::$post_id . '/revisions' ), $links['version-history'][0]['href'] );
+        $this->assertEquals( 0, $links['version-history'][0]['attributes']['count'] );
+        $this->assertFalse( isset( $links['predecessor-version'] ) );
 
         $attachments_url = rest_url( '/wp/v2/media' );
@@ -1309 +1311 @@
         $category_url = add_query_arg( 'post', self::$post_id, rest_url( '/wp/v2/categories' ) );
         $this->assertEquals( $category_url, $cat_link['href'] );
+    }
+
+    public function test_get_item_links_predecessor() {
+        wp_update_post(
+            array(
+                'post_content' => 'This content is marvelous.',
+                'ID'           => self::$post_id,
+            )
+        );
+        $revisions  = wp_get_post_revisions( self::$post_id );
+        $revision_1 = array_pop( $revisions );
+
+        $request  = new WP_REST_Request( 'GET', sprintf( '/wp/v2/posts/%d', self::$post_id ) );
+        $response = rest_get_server()->dispatch( $request );
+
+        $links = $response->get_links();
+
+        $this->assertEquals( rest_url( '/wp/v2/posts/' . self::$post_id . '/revisions' ), $links['version-history'][0]['href'] );
+        $this->assertEquals( 1, $links['version-history'][0]['attributes']['count'] );
+
+        $this->assertEquals( rest_url( '/wp/v2/posts/' . self::$post_id . '/revisions/' . $revision_1->ID ), $links['predecessor-version'][0]['href'] );
+        $this->assertEquals( $revision_1->ID, $links['predecessor-version'][0]['attributes']['id'] );
     }
 

trunk/tests/qunit/fixtures/wp-api-generated.js

@@ -3604 +3604 @@
             "version-history": [
                 {
+                    "count": 1,
                     "href": "http://example.org/index.php?rest_route=/wp/v2/posts/3/revisions"
+                }
+            ],
+            "predecessor-version": [
+                {
+                    "id": 3123,
+                    "href": "http://example.org/index.php?rest_route=/wp/v2/posts/3122/revisions/3123"
                 }
             ],
@@ -3789 +3796 @@
             "version-history": [
                 {
+                    "count": 1,
                     "href": "http://example.org/index.php?rest_route=/wp/v2/pages/5/revisions"
+                }
+            ],
+            "predecessor-version": [
+                {
+                    "id": 3125,
+                    "href": "http://example.org/index.php?rest_route=/wp/v2/pages/3124/revisions/3125"
                 }
             ],
@@ -3938 +3952 @@
             "self": [
                 {
+                    "attributes": [],
                     "href": "http://example.org/index.php?rest_route=/wp/v2/media/7"
                 }
@@ -3943 +3958 @@
             "collection": [
                 {
+                    "attributes": [],
                     "href": "http://example.org/index.php?rest_route=/wp/v2/media"
                 }
@@ -3948 +3964 @@
             "about": [
                 {
+                    "attributes": [],
                     "href": "http://example.org/index.php?rest_route=/wp/v2/types/attachment"
                 }
@@ -3953 +3970 @@
             "replies": [
                 {
-                    "embeddable": true,
+                    "attributes": {
+                        "embeddable": true
+                    },
                     "href": "http://example.org/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=7"
                 }