Skip to content

REST API: Guard against a non-array return from the rest_endpoints filter #13254

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
i-am-chitti wants to merge 1 commit into
base: trunk
Choose a base branch
from
+52 −0
Open

REST API: Guard against a non-array return from the rest_endpoints filter #13254

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions src/wp-includes/rest-api/class-wp-rest-server.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -972,6 +972,20 @@ public function get_routes( $route_namespace = '' ) {
*/
$endpoints = apply_filters( 'rest_endpoints', $endpoints );

if ( ! is_array( $endpoints ) ) {
_doing_it_wrong(
__METHOD__,
sprintf(
/* translators: %s: The name of the filter. */
__( 'The %s filter must return an array of endpoints.' ),
'<code>rest_endpoints</code>'
),
'7.2.0'
);

$endpoints = array();
}

// Normalize the endpoints.
$defaults = array(
'methods' => '',
Expand Down
38 changes: 38 additions & 0 deletions tests/phpunit/tests/rest-api/rest-server.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2082,6 +2082,44 @@ public function test_get_routes_no_namespace_overriding() {
$this->assertSame( 204, $response->get_status(), '/test-ns/v1/test' );
}

/**
* @ticket 65953
*/
public function test_get_routes_returns_array_when_rest_endpoints_filter_returns_null() {
$this->setExpectedIncorrectUsage( 'WP_REST_Server::get_routes' );

add_filter( 'rest_endpoints', '__return_null' );

$this->assertSame( array(), rest_get_server()->get_routes() );
}

/**
* @ticket 65953
*/
public function test_dispatch_does_not_error_when_rest_endpoints_filter_returns_null() {
$this->setExpectedIncorrectUsage( 'WP_REST_Server::get_routes' );

register_rest_route(
'test-ns/v1',
'/test',
array(
'methods' => array( 'GET' ),
'callback' => static function () {
return new WP_REST_Response( 'data', 204 );
},
'permission_callback' => '__return_true',
)
);

add_filter( 'rest_endpoints', '__return_null' );

$request = new WP_REST_Request( 'GET', '/test-ns/v1/test' );
$response = rest_get_server()->dispatch( $request );

$this->assertSame( 404, $response->get_status() );
$this->assertSame( 'rest_no_route', $response->as_error()->get_error_code() );
}

/**
* @ticket 50244
*/
Expand Down
Loading