Changeset 59458

Timestamp:

11/25/2024 11:14:37 AM (8 weeks ago)

Author:

Bernhard Reiter

Message:

REST API: Terms: Respect taxonomy's default query args.

It is possible to supply a set of default query args to register_taxonomy() which will be used when querying a list of terms -- for example, orderby in order to specify how the resulting list of terms should be sorted.

The Terms REST API controller previously respected these default query args only if the request included a post ID. This changeset makes it so that the default args will also be respected if no post ID is provided.

Props bernhard-reiter, jsnajdr.
Fixes #62500.

Location:

trunk

Files:

• src/wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php (modified) (2 diffs)
• tests/phpunit/tests/rest-api/rest-tags-controller.php (modified) (1 diff)

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

@@ -228 +228 @@
      *
      * @since 4.7.0
+     * @since 6.8.0 Respect default query arguments set for the taxonomy upon registration.
      *
      * @param WP_REST_Request $request Full details about the request.
@@ -294 +295 @@
                 }
             }
+        }
+
+        /*
+         * When a taxonomy is registered with an 'args' array,
+         * those params override the `$args` passed to this function.
+         *
+         * We only need to do this if no `post` argument is provided.
+         * Otherwise, terms will be fetched using `wp_get_object_terms()`,
+         * which respects the default query arguments set for the taxonomy.
+         */
+        if (
+            empty( $prepared_args['post'] ) &&
+            isset( $taxonomy_obj->args ) &&
+            is_array( $taxonomy_obj->args )
+        ) {
+            $prepared_args = array_merge( $prepared_args, $taxonomy_obj->args );
         }
 

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

@@ -481 +481 @@
         $this->assertCount( 2, $data );
         $this->assertSame( 'Cape', $data[0]['name'] );
+    }
+
+    /**
+     * @ticket 62500
+     */
+    public function test_get_items_custom_tax_without_post_arg_respects_tax_query_args() {
+        register_taxonomy(
+            'batman',
+            'post',
+            array(
+                'show_in_rest' => true,
+                'sort'         => true,
+                'args'         => array(
+                    'order'   => 'DESC',
+                    'orderby' => 'name',
+                ),
+            )
+        );
+        $controller = new WP_REST_Terms_Controller( 'batman' );
+        $controller->register_routes();
+        $term1 = self::factory()->term->create(
+            array(
+                'name'     => 'Cycle',
+                'taxonomy' => 'batman',
+            )
+        );
+        $term2 = self::factory()->term->create(
+            array(
+                'name'     => 'Pod',
+                'taxonomy' => 'batman',
+            )
+        );
+        $term3 = self::factory()->term->create(
+            array(
+                'name'     => 'Cave',
+                'taxonomy' => 'batman',
+            )
+        );
+
+        $request  = new WP_REST_Request( 'GET', '/wp/v2/batman' );
+        $response = rest_get_server()->dispatch( $request );
+        $this->assertSame( 200, $response->get_status() );
+
+        $data = $response->get_data();
+        $this->assertCount( 3, $data );
+        $this->assertSame(
+            array( 'Pod', 'Cycle', 'Cave' ),
+            array_column( $data, 'name' )
+        );
     }