Changeset 51964 for trunk/src/wp-includes/class-wp-taxonomy.php

Timestamp:

11/01/2021 03:26:06 AM (3 years ago)

Author:

TimothyBlynJacobs

Message:

REST API: Support custom namespaces for taxonomies.

While a taxonomy can define a custom route by using the rest_base argument, a namespace of wp/v2 was assumed. This commit introduces support for a rest_namespace argument.

A new rest_get_route_for_taxonomy_items function has been introduced and the rest_get_route_for_term function updated to facilitate getting the correct route for taxonomies.

For maximum compatibility sticking with the default wp/v2 namespace is recommended until the API functions see wider use.

Props spacedmonkey.
Fixes #54267.
See [51962].

File:

• trunk/src/wp-includes/class-wp-taxonomy.php (modified) (3 diffs)

trunk/src/wp-includes/class-wp-taxonomy.php

@@ -199 +199 @@
      */
     public $rest_base;
+
+    /**
+     * The namespace for this taxonomy's REST API endpoints.
+     *
+     * @since 5.9
+     * @var string|bool $rest_namespace
+     */
+    public $rest_namespace;
 
     /**
@@ -320 +328 @@
             'show_in_rest'          => false,
             'rest_base'             => false,
+            'rest_namespace'        => false,
             'rest_controller_class' => false,
             'default_term'          => null,
@@ -383 +392 @@
         if ( null === $args['show_in_quick_edit'] ) {
             $args['show_in_quick_edit'] = $args['show_ui'];
+        }
+
+        // If not set, default rest_namespace to wp/v2 if show_in_rest is true.
+        if ( false === $args['rest_namespace'] && ! empty( $args['show_in_rest'] ) ) {
+            $args['rest_namespace'] = 'wp/v2';
         }