Changeset 48526 for trunk/src/wp-includes/rest-api.php

Timestamp:

07/21/2020 12:01:10 PM (4 years ago)

Author:

TimothyBlynJacobs

Message:

REST API: Issue a _doing_it_wrong when registering a route without a permission callback.

The REST API treats routes without a permission_callback as public. Because this happens without any warning to the user, if the permission callback is unintentionally omitted or misspelled, the endpoint can end up being available to the public. Such a scenario has happened multiple times in the wild, and the results can be catostrophic when it occurs.

For REST API routes that are intended to be public, it is recommended to set the permission callback to the __return_true built in function.

Fixes #50075.
Props rmccue, sorenbronsted, whyisjake, SergeyBiryukov, TimothyBlynJacobs.

File:

• trunk/src/wp-includes/rest-api.php (modified) (1 diff)

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

@@ -89 +89 @@
         $arg_group         = array_merge( $defaults, $arg_group );
         $arg_group['args'] = array_merge( $common_args, $arg_group['args'] );
+
+        if ( ! isset( $arg_group['permission_callback'] ) ) {
+            _doing_it_wrong(
+                __FUNCTION__,
+                sprintf(
+                    /* translators: 1. The REST API route being registered. 2. The argument name. 3. The suggested function name. */
+                    __( 'The REST API route definition for %1$s is missing the required %2$s argument. For REST API routes that are intended to be public, use %3$s as the permission callback.', 'LION' ),
+                    '<code>' . $clean_namespace . '/' . trim( $route, '/' ) . '</code>',
+                    '<code>permission_callback</code>',
+                    '<code>__return_true</code>'
+                ),
+                '5.5.0'
+            );
+        }
     }