Changeset 51964 for trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-taxonomies-controller.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/rest-api/endpoints/class-wp-rest-taxonomies-controller.php (modified) (12 diffs)

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

@@ -251 +251 @@
         }
 
+        if ( in_array( 'rest_namespace', $fields, true ) ) {
+            $data['rest_namespace'] = $taxonomy->rest_namespace;
+        }
+
         if ( in_array( 'visibility', $fields, true ) ) {
             $data['visibility'] = array(
@@ -275 +279 @@
                 ),
                 'https://api.w.org/items' => array(
-                    'href' => rest_url( sprintf( 'wp/v2/%s', $base ) ),
+                    'href' => rest_url( rest_get_route_for_taxonomy_items( $taxonomy->name ) ),
                 ),
             )
@@ -311 +315 @@
             'type'       => 'object',
             'properties' => array(
-                'capabilities' => array(
+                'capabilities'   => array(
                     'description' => __( 'All capabilities used by the taxonomy.' ),
                     'type'        => 'object',
@@ -317 +321 @@
                     'readonly'    => true,
                 ),
-                'description'  => array(
+                'description'    => array(
                     'description' => __( 'A human-readable description of the taxonomy.' ),
                     'type'        => 'string',
@@ -323 +327 @@
                     'readonly'    => true,
                 ),
-                'hierarchical' => array(
+                'hierarchical'   => array(
                     'description' => __( 'Whether or not the taxonomy should have children.' ),
                     'type'        => 'boolean',
@@ -329 +333 @@
                     'readonly'    => true,
                 ),
-                'labels'       => array(
+                'labels'         => array(
                     'description' => __( 'Human-readable labels for the taxonomy for various contexts.' ),
                     'type'        => 'object',
@@ -335 +339 @@
                     'readonly'    => true,
                 ),
-                'name'         => array(
+                'name'           => array(
                     'description' => __( 'The title for the taxonomy.' ),
                     'type'        => 'string',
@@ -341 +345 @@
                     'readonly'    => true,
                 ),
-                'slug'         => array(
+                'slug'           => array(
                     'description' => __( 'An alphanumeric identifier for the taxonomy.' ),
                     'type'        => 'string',
@@ -347 +351 @@
                     'readonly'    => true,
                 ),
-                'show_cloud'   => array(
+                'show_cloud'     => array(
                     'description' => __( 'Whether or not the term cloud should be displayed.' ),
                     'type'        => 'boolean',
@@ -353 +357 @@
                     'readonly'    => true,
                 ),
-                'types'        => array(
+                'types'          => array(
                     'description' => __( 'Types associated with the taxonomy.' ),
                     'type'        => 'array',
@@ -362 +366 @@
                     'readonly'    => true,
                 ),
-                'rest_base'    => array(
+                'rest_base'      => array(
                     'description' => __( 'REST base route for the taxonomy.' ),
                     'type'        => 'string',
@@ -368 +372 @@
                     'readonly'    => true,
                 ),
-                'visibility'   => array(
+                'rest_namespace' => array(
+                    'description' => __( 'REST namespace route for the taxonomy.' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view', 'edit', 'embed' ),
+                    'readonly'    => true,
+                ),
+                'visibility'     => array(
                     'description' => __( 'The visibility settings for the taxonomy.' ),
                     'type'        => 'object',