Changeset 48273

Timestamp:

07/02/2020 05:55:04 AM (6 years ago)

Author:

TimothyBlynJacobs

Message:

REST API: Link to the REST route for the currently queried resource.

This allows for programatically determining the REST version of the current page. The links also aid human discovery of the REST API in general.

Props dshanske, tfrommen, TimothyBlynJacobs.
Fixes #49116.

Location:

trunk

Files:

• src/wp-includes/class-wp-taxonomy.php (modified) (2 diffs)
• src/wp-includes/rest-api.php (modified) (4 diffs)
• tests/phpunit/tests/rest-api.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-taxonomies-controller.php (modified) (1 diff)

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

@@ -209 +209 @@
          */
         public $rest_controller_class;
+
+        /**
+         * The controller instance for this taxonomy's REST API endpoints.
+         *
+         * Lazily computed. Should be accessed using {@see WP_Taxonomy::get_rest_controller()}.
+         *
+         * @since 5.5.0
+         * @var WP_REST_Controller $rest_controller
+         */
+        public $rest_controller;
 
         /**
@@ -453 +463 @@
                 remove_filter( 'wp_ajax_add-' . $this->name, '_wp_ajax_add_hierarchical_term' );
         }
+
+        /**
+         * Gets the REST API controller for this taxonomy.
+         *
+         * Will only instantiate the controller class once per request.
+         *
+         * @since 5.5.0
+         *
+         * @return WP_REST_Controller|null The controller instance, or null if the taxonomy
+         *                                 is set not to show in rest.
+         */
+        public function get_rest_controller() {
+                if ( ! $this->show_in_rest ) {
+                        return null;
+                }
+
+                $class = $this->rest_controller_class ? $this->rest_controller_class : WP_REST_Terms_Controller::class;
+
+                if ( ! class_exists( $class ) ) {
+                        return null;
+                }
+
+                if ( ! is_subclass_of( $class, WP_REST_Controller::class ) ) {
+                        return null;
+                }
+
+                if ( ! $this->rest_controller ) {
+                        $this->rest_controller = new $class( $this->name );
+                }
+
+                if ( ! ( $this->rest_controller instanceof $class ) ) {
+                        return null;
+                }
+
+                return $this->rest_controller;
+        }
 }

trunk/src/wp-includes/rest-api.php

@@ -235 +235 @@
         // Terms.
         foreach ( get_taxonomies( array( 'show_in_rest' => true ), 'object' ) as $taxonomy ) {
-                $class = ! empty( $taxonomy->rest_controller_class ) ? $taxonomy->rest_controller_class : 'WP_REST_Terms_Controller';
-
-                if ( ! class_exists( $class ) ) {
-                        continue;
-                }
-                $controller = new $class( $taxonomy->name );
-                if ( ! is_subclass_of( $controller, 'WP_REST_Controller' ) ) {
+                $controller = $taxonomy->get_rest_controller();
+
+                if ( ! $controller ) {
                         continue;
                 }
@@ -874 +870 @@
         }
 
-        echo "<link rel='https://api.w.org/' href='" . esc_url( $api_root ) . "' />\n";
+        printf( '<link rel="https://api.w.org/" href="%s" />', esc_url( $api_root ) );
+
+        $resource = rest_get_queried_resource_route();
+
+        if ( $resource ) {
+                printf( '<link rel="alternate" type="application/json" href="%s" />', esc_url( rest_url( $resource ) ) );
+        }
 }
 
@@ -893 +895 @@
         }
 
-        header( 'Link: <' . esc_url_raw( $api_root ) . '>; rel="https://api.w.org/"', false );
+        header( sprintf( 'Link: <%s>; rel="https://api.w.org/"', esc_url_raw( $api_root ) ), false );
+
+        $resource = rest_get_queried_resource_route();
+
+        if ( $resource ) {
+                header( sprintf( 'Link: <%s>; rel="alternate"; type="application/json"', esc_url_raw( rest_url( $resource ) ) ), false );
+        }
 }
 
@@ -1824 +1832 @@
         return $schema;
 }
+
+/**
+ * Gets the REST API route for a post.
+ *
+ * @since 5.5.0
+ *
+ * @param int|WP_Post $post Post ID or post object.
+ * @return string The route path with a leading slash for the given post, or an empty string if there is not a route.
+ */
+function rest_get_route_for_post( $post ) {
+        $post = get_post( $post );
+
+        if ( ! $post instanceof WP_Post ) {
+                return '';
+        }
+
+        $post_type = get_post_type_object( $post->post_type );
+        if ( ! $post_type ) {
+                return '';
+        }
+
+        $controller = $post_type->get_rest_controller();
+        if ( ! $controller ) {
+                return '';
+        }
+
+        $route = '';
+
+        // The only two controllers that we can detect are the Attachments and Posts controllers.
+        if ( in_array( get_class( $controller ), array( 'WP_REST_Attachments_Controller', 'WP_REST_Posts_Controller' ), true ) ) {
+                $namespace = 'wp/v2';
+                $rest_base = ! empty( $post_type->rest_base ) ? $post_type->rest_base : $post_type->name;
+                $route     = sprintf( '/%s/%s/%d', $namespace, $rest_base, $post->ID );
+        }
+
+        /**
+         * Filters the REST API route for a post.
+         *
+         * @since 5.5.0
+         *
+         * @param string  $route The route path.
+         * @param WP_Post $post  The post object.
+         */
+        return apply_filters( 'rest_route_for_post', $route, $post );
+}
+
+/**
+ * Gets the REST API route for a term.
+ *
+ * @since 5.5.0
+ *
+ * @param int|WP_Term $term Term ID or term object.
+ * @return string The route path with a leading slash for the given term, or an empty string if there is not a route.
+ */
+function rest_get_route_for_term( $term ) {
+        $term = get_term( $term );
+
+        if ( ! $term instanceof WP_Term ) {
+                return '';
+        }
+
+        $taxonomy = get_taxonomy( $term->taxonomy );
+        if ( ! $taxonomy ) {
+                return '';
+        }
+
+        $controller = $taxonomy->get_rest_controller();
+        if ( ! $controller ) {
+                return '';
+        }
+
+        $route = '';
+
+        // The only controller that works is the Terms controller.
+        if ( 'WP_REST_Terms_Controller' === get_class( $controller ) ) {
+                $namespace = 'wp/v2';
+                $rest_base = ! empty( $taxonomy->rest_base ) ? $taxonomy->rest_base : $taxonomy->name;
+                $route     = sprintf( '/%s/%s/%d', $namespace, $rest_base, $term->term_id );
+        }
+
+        /**
+         * Filters the REST API route for a term.
+         *
+         * @since 5.5.0
+         *
+         * @param string  $route The route path.
+         * @param WP_Term $term  The term object.
+         */
+        return apply_filters( 'rest_route_for_term', $route, $term );
+}
+
+/**
+ * Gets the REST route for the currently queried object.
+ *
+ * @since 5.5.0
+ *
+ * @return string The REST route of the resource, or an empty string if no resource identified.
+ */
+function rest_get_queried_resource_route() {
+        if ( is_singular() ) {
+                $route = rest_get_route_for_post( get_queried_object() );
+        } elseif ( is_category() || is_tag() || is_tax() ) {
+                $route = rest_get_route_for_term( get_queried_object() );
+        } elseif ( is_author() ) {
+                $route = '/wp/v2/users/' . get_queried_object_id();
+        } else {
+                $route = '';
+        }
+
+        /**
+         * Filters the REST route for the currently queried object.
+         *
+         * @since 5.5.0
+         *
+         * @param string $link The route with a leading slash, or an empty string.
+         */
+        return apply_filters( 'rest_queried_resource_route', $route );
+}

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

@@ -1350 +1350 @@
                 );
         }
+
+        /**
+         * @ticket 49116
+         */
+        public function test_rest_get_route_for_post_non_post() {
+                $this->assertEquals( '', rest_get_route_for_post( 'garbage' ) );
+        }
+
+        /**
+         * @ticket 49116
+         */
+        public function test_rest_get_route_for_post_invalid_post_type() {
+                register_post_type( 'invalid' );
+                $post = self::factory()->post->create_and_get( array( 'post_type' => 'invalid' ) );
+                unregister_post_type( 'invalid' );
+
+                $this->assertEquals( '', rest_get_route_for_post( $post ) );
+        }
+
+        /**
+         * @ticket 49116
+         */
+        public function test_rest_get_route_for_post_non_rest() {
+                $post = self::factory()->post->create_and_get( array( 'post_type' => 'custom_css' ) );
+                $this->assertEquals( '', rest_get_route_for_post( $post ) );
+        }
+
+        /**
+         * @ticket 49116
+         */
+        public function test_rest_get_route_for_post_custom_controller() {
+                $post = self::factory()->post->create_and_get( array( 'post_type' => 'wp_block' ) );
+                $this->assertEquals( '', rest_get_route_for_post( $post ) );
+        }
+
+        /**
+         * @ticket 49116
+         */
+        public function test_rest_get_route_for_post() {
+                $post = self::factory()->post->create_and_get();
+                $this->assertEquals( '/wp/v2/posts/' . $post->ID, rest_get_route_for_post( $post ) );
+        }
+
+        /**
+         * @ticket 49116
+         */
+        public function test_rest_get_route_for_media() {
+                $post = self::factory()->attachment->create_and_get();
+                $this->assertEquals( '/wp/v2/media/' . $post->ID, rest_get_route_for_post( $post ) );
+        }
+
+        /**
+         * @ticket 49116
+         */
+        public function test_rest_get_route_for_post_id() {
+                $post = self::factory()->post->create_and_get();
+                $this->assertEquals( '/wp/v2/posts/' . $post->ID, rest_get_route_for_post( $post->ID ) );
+        }
+
+        /**
+         * @ticket 49116
+         */
+        public function test_rest_get_route_for_term_non_term() {
+                $this->assertEquals( '', rest_get_route_for_term( 'garbage' ) );
+        }
+
+        /**
+         * @ticket 49116
+         */
+        public function test_rest_get_route_for_term_invalid_term_type() {
+                register_taxonomy( 'invalid', 'post' );
+                $term = self::factory()->term->create_and_get( array( 'taxonomy' => 'invalid' ) );
+                unregister_taxonomy( 'invalid' );
+
+                $this->assertEquals( '', rest_get_route_for_term( $term ) );
+        }
+
+        /**
+         * @ticket 49116
+         */
+        public function test_rest_get_route_for_term_non_rest() {
+                $term = self::factory()->term->create_and_get( array( 'taxonomy' => 'post_format' ) );
+                $this->assertEquals( '', rest_get_route_for_term( $term ) );
+        }
+
+        /**
+         * @ticket 49116
+         */
+        public function test_rest_get_route_for_term() {
+                $term = self::factory()->term->create_and_get();
+                $this->assertEquals( '/wp/v2/tags/' . $term->term_id, rest_get_route_for_term( $term ) );
+        }
+
+        /**
+         * @ticket 49116
+         */
+        public function test_rest_get_route_for_category() {
+                $term = self::factory()->category->create_and_get();
+                $this->assertEquals( '/wp/v2/categories/' . $term->term_id, rest_get_route_for_term( $term ) );
+        }
+
+        /**
+         * @ticket 49116
+         */
+        public function test_rest_get_route_for_term_id() {
+                $term = self::factory()->term->create_and_get();
+                $this->assertEquals( '/wp/v2/tags/' . $term->term_id, rest_get_route_for_term( $term->term_id ) );
+        }
 }

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

@@ -292 +292 @@
         }
 
+        /**
+         * @ticket 49116
+         */
+        public function test_get_for_taxonomy_reuses_same_instance() {
+                $this->assertSame(
+                        get_taxonomy( 'category' )->get_rest_controller(),
+                        get_taxonomy( 'category' )->get_rest_controller()
+                );
+        }
+
+        /**
+         * @ticket 49116
+         */
+        public function test_get_for_taxonomy_returns_terms_controller_if_custom_class_not_specified() {
+                register_taxonomy(
+                        'test',
+                        'post',
+                        array(
+                                'show_in_rest' => true,
+                        )
+                );
+
+                $this->assertInstanceOf(
+                        WP_REST_Terms_Controller::class,
+                        get_taxonomy( 'test' )->get_rest_controller()
+                );
+        }
+
 }