Ticket #39494: 39494.3.diff

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

@@ -270 +270 @@
                 foreach ( $taxonomies as $taxonomy ) {
                         $base        = ! empty( $taxonomy->rest_base ) ? $taxonomy->rest_base : $taxonomy->name;
                         $tax_exclude = $base . '_exclude';
+                        $tax_object  = $base . '_object';
 
                         if ( ! empty( $request[ $base ] ) ) {
                                 $query_args['tax_query'][] = array(
@@ -280 +281 @@
                                 );
                         }
 
+                        if ( ! empty( $request[ $tax_object ] ) ) {
+                                $terms            = array();
+                                $include_children = false;
+                                $field            = 'term_id';
+
+                                if ( isset( $request[ $tax_object ]['term_ids'] ) ) {
+                                        $terms = $request[ $tax_object ]['term_ids'];
+                                }
+
+                                if ( isset( $request[ $tax_object ]['term_slugs'] ) ) {
+                                        $field = 'slug';
+                                        $terms = $request[ $tax_object ]['term_slugs'];
+                                }
+
+                                if ( isset( $request[ $tax_object ]['include_children'] ) ) {
+                                        $include_children = $request[ $tax_object ]['include_children'];
+                                }
+
+                                $query_args['tax_query'][] = array(
+                                        'taxonomy'         => $taxonomy->name,
+                                        'field'            => $field,
+                                        'terms'            => $terms,
+                                        'include_children' => $include_children,
+                                );
+                        }
+
                         if ( ! empty( $request[ $tax_exclude ] ) ) {
                                 $query_args['tax_query'][] = array(
                                         'taxonomy'         => $taxonomy->name,
@@ -2230 +2257 @@
                                 'default'     => array(),
                         );
 
+                        $query_params[ $base . '_object' ] = array(
+                                /* translators: %s: taxonomy name */
+                                'description' => sprintf( __( 'Limit result set to all items that have the specified term assigned in the %s taxonomy.' ), $base ),
+                                'type'        => 'object',
+                                'properties'  => array(
+                                        'term_ids'              => array(
+                                                'description' => __( 'The term ids to limit the post to.' ),
+                                                'type'        => 'array',
+                                                'items'       => array(
+                                                        'type' => 'integer',
+                                                ),
+                                                'default'     => array(),
+                                        ),
+                                        'term_slugs'              => array(
+                                                'description' => __( 'The term slugs to limit the post to.' ),
+                                                'type'        => 'array',
+                                                'items'       => array(
+                                                        'type' => 'string',
+                                                ),
+                                                'default'     => array(),
+                                        ),
+                                        'include_children' => array(
+                                                'description' => __( 'Whether or not to include the term children.' ),
+                                                'type'        => 'boolean',
+                                                'default'     => false,
+                                        ),
+                                ),
+                        );
+
                         $query_params[ $base . '_exclude' ] = array(
                                 /* translators: %s: taxonomy name */
                                 'description' => sprintf( __( 'Limit result set to all items except those that have the specified term assigned in the %s taxonomy.' ), $base ),

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

@@ -147 +147 @@
                                 'before',
                                 'categories',
                                 'categories_exclude',
+                                'categories_object',
                                 'context',
                                 'exclude',
                                 'include',
@@ -161 +162 @@
                                 'sticky',
                                 'tags',
                                 'tags_exclude',
+                                'tags_object',
                         ), $keys
                 );
         }
@@ -934 +936 @@
                 $this->assertErrorResponse( 'rest_invalid_param', $response, 400 );
         }
 
+        /**
+         * Testing updated taxonomy schema and including category children.
+         *
+         * @ticket 39494
+         */
+        public function test_get_items_categories_by_term_ids_and_include_children_true() {
+                $id1 = $this->factory->post->create( array( 'post_status' => 'publish' ) );
+                $id2 = $this->factory->post->create( array( 'post_status' => 'publish' ) );
+
+                $cat1 = wp_insert_term( 'My Parent Category', 'category' );
+                $cat2 = wp_insert_term( 'My Child Category', 'category', array( 'parent' => $cat1['term_id'] ) );
+
+                wp_set_object_terms( $id1, array( $cat1['term_id'] ), 'category' );
+                wp_set_object_terms( $id2, array( $cat2['term_id'] ), 'category' );
+
+                $request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
+                $request->set_param( 'categories_object', (object) array(
+                        'term_ids'         => array( $cat1['term_id'] ),
+                        'include_children' => true,
+                ) );
+                $response = rest_get_server()->dispatch( $request );
+                $data     = $response->get_data();
+
+                $this->assertCount( 2, $data );
+                $this->assertEquals( $id1, $data[0]['id'] );
+                $this->assertEquals( $id2, $data[1]['id'] );
+        }
+
+        /**
+         * Testing updated taxonomy schema without including category children.
+         *
+         * @ticket 39494
+         */
+        public function test_get_items_categories_by_term_ids_and_include_children_false() {
+                $id1 = $this->factory->post->create( array( 'post_status' => 'publish' ) );
+                $id2 = $this->factory->post->create( array( 'post_status' => 'publish' ) );
+
+                $cat1 = wp_insert_term( 'My Parent Category', 'category' );
+                $cat2 = wp_insert_term( 'My Child Category', 'category', array( 'parent' => $cat1['term_id'] ) );
+
+                wp_set_object_terms( $id1, array( $cat1['term_id'] ), 'category' );
+                wp_set_object_terms( $id2, array( $cat2['term_id'] ), 'category' );
+
+                $request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
+                $request->set_param( 'categories_object', (object) array(
+                        'term_ids'         => array( $cat1['term_id'] ),
+                        'include_children' => false,
+                ) );
+                $response = rest_get_server()->dispatch( $request );
+                $data     = $response->get_data();
+
+                $this->assertCount( 1, $data );
+                $this->assertEquals( $id1, $data[0]['id'] );
+        }
+
+        /**
+         * Testing updated taxonomy schema by searching for term slugs and including category children.
+         *
+         * @ticket 39494
+         */
+        public function test_get_items_categories_by_term_slugs_and_include_children_true() {
+                $id1 = $this->factory->post->create( array( 'post_status' => 'publish' ) );
+                $id2 = $this->factory->post->create( array( 'post_status' => 'publish' ) );
+
+                $cat1 = wp_insert_term( 'My Parent Category', 'category' );
+                $cat2 = wp_insert_term( 'My Child Category', 'category', array( 'parent' => $cat1['term_id'] ) );
+
+                wp_set_object_terms( $id1, array( $cat1['term_id'] ), 'category' );
+                wp_set_object_terms( $id2, array( $cat2['term_id'] ), 'category' );
+
+                $cat1_slug = get_term_by( 'term_id', $cat1['term_id'], 'category' )->slug;
+
+                $request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
+                $request->set_param( 'categories_object', (object) array(
+                        'term_slugs'       => array( $cat1_slug ),
+                        'include_children' => true,
+                ) );
+                $response = rest_get_server()->dispatch( $request );
+                $data     = $response->get_data();
+
+                $this->assertCount( 2, $data );
+                $this->assertEquals( $id1, $data[0]['id'] );
+                $this->assertEquals( $id2, $data[1]['id'] );
+        }
+
+        /**
+         * Testing updated taxonomy schema by searching for term slugs and not including category children.
+         *
+         * @ticket 39494
+         */
+        public function test_get_items_categories_by_term_slugs_and_include_children_false() {
+                $id1 = $this->factory->post->create( array( 'post_status' => 'publish' ) );
+                $id2 = $this->factory->post->create( array( 'post_status' => 'publish' ) );
+
+                $cat1 = wp_insert_term( 'My Parent Category', 'category' );
+                $cat2 = wp_insert_term( 'My Child Category', 'category', array( 'parent' => $cat1['term_id'] ) );
+
+                wp_set_object_terms( $id1, array( $cat1['term_id'] ), 'category' );
+                wp_set_object_terms( $id2, array( $cat2['term_id'] ), 'category' );
+
+                $cat1_slug = get_term_by( 'term_id', $cat1['term_id'], 'category' )->slug;
+
+                $request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
+                $request->set_param( 'categories_object', (object) array(
+                        'term_slugs'       => array( $cat1_slug ),
+                        'include_children' => false,
+                ) );
+                $response = rest_get_server()->dispatch( $request );
+                $data     = $response->get_data();
+
+                $this->assertCount( 1, $data );
+                $this->assertEquals( $id1, $data[0]['id'] );
+        }
+
         public function test_get_items_sticky() {
                 $id1 = self::$post_id;
                 $id2 = $this->factory->post->create( array( 'post_status' => 'publish' ) );