Changeset 51962 for trunk/src/wp-includes/class-wp-post-type.php

Timestamp:

10/31/2021 11:15:10 PM (3 years ago)

Author:

TimothyBlynJacobs

Message:

REST API: Support custom namespaces for custom post types.

While a custom post type 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_post_type_items function has been introduced and the rest_get_route_for_post function updated to facilitate getting the correct route for custom post types.

While the WordPress Core Block Editor bootstrap code has been updated to use these API functions, for maximum compatibility sticking with the default wp/v2 namespace is recommended until the API functions see wider use.

Props spacedmonkey, swissspidy.
Fixes #53656.

File:

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

trunk/src/wp-includes/class-wp-post-type.php

@@ -358 +358 @@
      */
     public $rest_base;
+
+    /**
+     * The namespace for this post type's REST API endpoints.
+     *
+     * @since 5.9
+     * @var string|bool $rest_namespace
+     */
+    public $rest_namespace;
 
     /**
@@ -453 +461 @@
             'show_in_rest'          => false,
             'rest_base'             => false,
+            'rest_namespace'        => false,
             'rest_controller_class' => false,
             'template'              => array(),
@@ -472 +481 @@
         if ( null === $args['show_ui'] ) {
             $args['show_ui'] = $args['public'];
+        }
+
+        // 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';
         }