Changeset 46435

Timestamp:

10/08/2019 01:41:29 PM (5 years ago)

Author:

kadamwhite

Message:

REST API: Ensure rest_controller instantiates the post type's declared REST controller class.

Ensures that the ::get_rest_controller() method will always return an instanceof the expected controller class, or null.
Removes unused private static property $post_type_controllers.

Props dlh, TimothyBlynJacobs.
Fixes #45677.

Location:

trunk

Files:

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

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

@@ -344 +344 @@
      * @var WP_REST_Controller $rest_controller
      */
-    private $rest_controller;
+    public $rest_controller;
 
     /**
@@ -723 +723 @@
         }
 
+        if ( ! ( $this->rest_controller instanceof $class ) ) {
+            return null;
+        }
+
         return $this->rest_controller;
     }

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

@@ -16 +16 @@
  */
 class WP_REST_Posts_Controller extends WP_REST_Controller {
-
-    /**
-     * Instances of post type controllers keyed by post type.
-     *
-     * @since 5.3.0
-     * @var WP_REST_Controller[]
-     */
-    private static $post_type_controllers = array();
-
     /**
      * Post type.

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

@@ -4618 +4618 @@
     }
 
+    /**
+     * @ticket 45677
+     */
+    public function test_get_for_post_type_returns_null_for_invalid_provided_controller() {
+        register_post_type(
+            'test',
+            array(
+                'show_in_rest'    => true,
+                'rest_controller' => new \stdClass(),
+            )
+        );
+
+        $this->assertNull( get_post_type_object( 'test' )->get_rest_controller() );
+    }
+
+    /**
+     * @ticket 45677
+     */
+    public function test_get_for_post_type_returns_null_for_controller_class_mismatch() {
+        register_post_type(
+            'test',
+            array(
+                'show_in_rest'          => true,
+                'rest_controller_class' => WP_REST_Posts_Controller::class,
+                'rest_controller'       => new WP_REST_Terms_Controller( 'category' ),
+            )
+        );
+
+        $this->assertNull( get_post_type_object( 'test' )->get_rest_controller() );
+    }
+
     public function tearDown() {
         _unregister_post_type( 'private-post' );