Changeset 44568

Timestamp:

01/11/2019 06:18:41 PM (6 years ago)

Author:

desrosj

Message:

REST API: Encourage proper usage of register_rest_route().

Calling register_rest_route() too early in the loading process has the potential to cause some unintentional problems and pitfalls. Because register_rest_route() calls rest_get_server() (which creates the WP_REST_Server instance), calling the function directly and/or before rest_api_init should be discouraged.

For example, if register_rest_route () is called on init, the REST API server instance is set up (and all functions added to rest_api_init and other related hooks are invoked), even though the current request may not be a REST request. Also, if register_rest_route() is called even earlier (say, in an mu-plugin file), required endpoints may be missing since normal plugins have not yet been loaded and have not had a chance to register their own action hooks.

This adds a _doing_it_wrong() notice the first time register_rest_route() is called before rest_api_init in a request to encourage best practices for registering REST API routes.

Props kraftbj, desrosj, timothyblynjacobs.
Fixes #45265.

Location:

trunk

Files:

• src/wp-includes/rest-api.php (modified) (2 diffs)
• tests/phpunit/tests/rest-api.php (modified) (1 diff)

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

@@ -18 +18 @@
  * Registers a REST API route.
  *
- * @since 4.4.0
+ * Note: Do not use before the {@see 'rest_api_init'} hook.
+ *
+ * @since 4.4.0
+ * @since 5.1.0 Added a _doing_it_wrong() notice when not called on or after the rest_api_init hook.
  *
  * @param string $namespace The first URL segment after core prefix. Should be unique to your package/plugin.
@@ -40 +43 @@
         _doing_it_wrong( 'register_rest_route', __( 'Route must be specified.' ), '4.4.0' );
         return false;
+    }
+
+    if ( ! did_action( 'rest_api_init' ) ) {
+        _doing_it_wrong( 'register_rest_route', __( 'REST API routes must be registered on the rest_api_init action.' ), '5.1.0' );
     }
 

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

@@ -15 +15 @@
 class Tests_REST_API extends WP_UnitTestCase {
     public function setUp() {
+        parent::setUp();
+
         // Override the normal server with our spying server.
         $GLOBALS['wp_rest_server'] = new Spy_REST_Server();
-        parent::setUp();
+        do_action( 'rest_api_init', $GLOBALS['wp_rest_server'] );
     }