Changeset 41760

Timestamp:

10/05/2017 12:36:43 AM (7 years ago)

Author:

kadamwhite

Message:

REST API: Support ordering response collection by listed slugs.

Adds an "include_slug" orderby value for REST API collections to permit returning a collection filtered by slugs in the same order in which those slugs are specified.
Previously, the order of slugs provided with the ?slug query parameter had no effect on the order of the returned records.

Props wonderboymusic, ocean90, boonebgorges.
Fixes #40826.

Location:

trunk

Files:

• src/wp-includes/class-wp-term-query.php (modified) (3 diffs)
• src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php (modified) (2 diffs)
• src/wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php (modified) (2 diffs)
• src/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php (modified) (2 diffs)
• tests/phpunit/tests/rest-api/rest-categories-controller.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-posts-controller.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-tags-controller.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-users-controller.php (modified) (1 diff)
• tests/qunit/fixtures/wp-api-generated.js (modified) (6 diffs)

trunk/src/wp-includes/class-wp-term-query.php

@@ -88 +88 @@
      * @since 4.6.0 Introduced 'term_taxonomy_id' parameter.
      * @since 4.7.0 Introduced 'object_ids' parameter.
+
      *
      * @param string|array $query {
@@ -99 +100 @@
      *                                                'slug', 'term_group', 'term_id', 'id', 'description', 'parent'),
      *                                                'count' for term taxonomy count, 'include' to match the
-     *                                                'order' of the $include param, 'meta_value', 'meta_value_num',
+     *                                                'order' of the $include param, 'slug__in' to match the
+     *                                                'order' of the $slug param, 'meta_value', 'meta_value_num',
      *                                                the value of `$meta_key`, the array keys of `$meta_query`, or
      *                                                'none' to omit the ORDER BY clause. Defaults to 'name'.
@@ -842 +844 @@
             $include = implode( ',', wp_parse_id_list( $this->query_vars['include'] ) );
             $orderby = "FIELD( t.term_id, $include )";
+
+
+
         } elseif ( 'none' == $_orderby ) {
             $orderby = '';

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

@@ -875 +875 @@
         if ( isset( $query_args['orderby'] ) && isset( $request['orderby'] ) ) {
             $orderby_mappings = array(
-                'id'      => 'ID',
-                'include' => 'post__in',
-                'slug'    => 'post_name',
+                'id'            => 'ID',
+                'include'       => 'post__in',
+                'slug'          => 'post_name',
+                'include_slugs' => 'post_name__in',
             );
 
@@ -2110 +2111 @@
                 'relevance',
                 'slug',
+
                 'title',
             ),

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

@@ -186 +186 @@
             if ( isset( $registered[ $api_param ], $request[ $api_param ] ) ) {
                 $prepared_args[ $wp_param ] = $request[ $api_param ];
+
+
+
+
+
+
+
+
+
+
             }
         }
@@ -933 +943 @@
                 'name',
                 'slug',
+
                 'term_group',
                 'description',

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

@@ -244 +244 @@
                 'registered_date' => 'registered',
                 'slug'            => 'user_nicename',
+
                 'email'           => 'user_email',
                 'url'             => 'user_url',
@@ -1339 +1340 @@
                 'registered_date',
                 'slug',
+
                 'email',
                 'url',

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

@@ -288 +288 @@
     }
 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
     protected function post_with_categories() {
         $post_id = $this->factory->post->create();

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

@@ -597 +597 @@
         $this->assertEquals( 'abc', $data[1]['slug'] );
         $this->assertPostsOrderedBy( '{posts}.post_name DESC' );
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
     }
 

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

@@ -249 +249 @@
         $this->assertEquals( 'Apple', $data[1]['name'] );
         $this->assertEquals( 'Cantaloupe', $data[2]['name'] );
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
     }
 

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

@@ -408 +408 @@
         $data = $response->get_data();
         $this->assertEquals( $low_id, $data[0]['id'] );
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
     }
 

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

@@ -285 +285 @@
                                 "relevance",
                                 "slug",
+
                                 "title"
                             ],
@@ -906 +907 @@
                                 "relevance",
                                 "slug",
+
                                 "title",
                                 "menu_order"
@@ -1444 +1446 @@
                                 "relevance",
                                 "slug",
+
                                 "title"
                             ],
@@ -2024 +2027 @@
                                 "name",
                                 "slug",
+
                                 "term_group",
                                 "description",
@@ -2267 +2271 @@
                                 "name",
                                 "slug",
+
                                 "term_group",
                                 "description",
@@ -2496 +2501 @@
                                 "registered_date",
                                 "slug",
+
                                 "email",
                                 "url"