Changeset 58933

Timestamp:

08/25/2024 10:49:05 PM (7 weeks ago)

Author:

TimothyBlynJacobs

Message:

REST API: Improve error messages when registering an invalid route.

The error messages now include the REST API namespace and route to help identify the offending code.

Props lwangaman, timothyblynjacobs.
Fixes #50493.

File:

• trunk/src/wp-includes/rest-api.php (modified) (2 diffs)

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

@@ -39 +39 @@
          * non-namespaced route, call `WP_REST_Server::register_route` directly.
          */
-        _doing_it_wrong( 'register_rest_route', __( 'Routes must be namespaced with plugin or theme name and version.' ), '4.4.0' );
+        _doing_it_wrong(
+            __FUNCTION__,
+            sprintf(
+                /* translators: 1: string value of the namespace, 2: string value of the route. */
+                __( 'Routes must be namespaced with plugin or theme name and version. Instead there seems to be an empty namespace \'%1$s\' for route \'%2$s\'.' ),
+                '<code>' . $route_namespace . '</code>',
+                '<code>' . $route . '</code>'
+            ),
+            '4.4.0'
+        );
         return false;
     } elseif ( empty( $route ) ) {
-        _doing_it_wrong( 'register_rest_route', __( 'Route must be specified.' ), '4.4.0' );
+        _doing_it_wrong(
+            __FUNCTION__,
+            sprintf(
+                /* translators: 1: string value of the namespace, 2: string value of the route. */
+                __( 'Route must be specified. Instead within the namespace \'%1$s\', there seems to be an empty route \'%2$s\'.' ),
+                '<code>' . $route_namespace . '</code>',
+                '<code>' . $route . '</code>'
+            ),
+            '4.4.0'
+        );
         return false;
     }
@@ -49 +67 @@
 
     if ( $clean_namespace !== $route_namespace ) {
-        _doing_it_wrong( __FUNCTION__, __( 'Namespace must not start or end with a slash.' ), '5.4.2' );
+        _doing_it_wrong(
+            __FUNCTION__,
+            sprintf(
+                /* translators: 1: string value of the namespace, 2: string value of the route. */
+                __( 'Namespace must not start or end with a slash. Instead namespace \'%1$s\' for route \'%2$s\' seems to contain a slash.' ),
+                '<code>' . $route_namespace . '</code>',
+                '<code>' . $route . '</code>'
+            ),
+            '5.4.2'
+        );
     }
 
     if ( ! did_action( 'rest_api_init' ) ) {
         _doing_it_wrong(
-            'register_rest_route',
+            __FUNCTION__,
             sprintf(
-                /* translators: %s: rest_api_init */
-                __( 'REST API routes must be registered on the %s action.' ),
-                '<code>rest_api_init</code>'
+                /* translators: 1: rest_api_init, 2: string value of the route, 3: string value of the namespace. */
+                __( 'REST API routes must be registered on the %1$s action. Instead route \'%2$s\' with namespace \'%3$s\' was not registered on this action.' ),
+                '<code>rest_api_init</code>',
+                '<code>' . $route . '</code>',
+                '<code>' . $route_namespace . '</code>'
             ),
             '5.1.0'