Skip to content

Widgets: Reject REST widget IDs that end in a newline or match no widget. #15314

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
ekamran wants to merge 1 commit into
base: trunk
Choose a base branch
from
Open

Widgets: Reject REST widget IDs that end in a newline or match no widget. #15314

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
7 changes: 4 additions & 3 deletions src/wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,12 +289,13 @@ public function update_item_permissions_check( $request ) {
* @since 5.8.0
*
* @global WP_Widget_Factory $wp_widget_factory
* @global array $wp_registered_widgets The registered widgets.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
*/
public function update_item( $request ) {
global $wp_widget_factory;
global $wp_widget_factory, $wp_registered_widgets;

/*
* retrieve_widgets() contains logic to move "hidden" or "lost" widgets to the
Expand All @@ -312,10 +313,10 @@ public function update_item( $request ) {
$widget_id = $request['id'];
$sidebar_id = wp_find_widgets_sidebar( $widget_id );

// Allow sidebar to be unset or missing when widget is not a WP_Widget.
// Allow sidebar to be unset or missing for a registered widget that is not a WP_Widget.
$parsed_id = wp_parse_widget_id( $widget_id );
$widget_object = $wp_widget_factory->get_widget_object( $parsed_id['id_base'] );
if ( is_null( $sidebar_id ) && $widget_object ) {
if ( is_null( $sidebar_id ) && ( $widget_object || ! isset( $wp_registered_widgets[ $widget_id ] ) ) ) {
return new WP_Error(
'rest_widget_not_found',
__( 'No widget was found with that id.' ),
Expand Down
2 changes: 1 addition & 1 deletion src/wp-includes/widgets.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1941,7 +1941,7 @@ function wp_use_widgets_block_editor() {
function wp_parse_widget_id( $id ) {
$parsed = array();

if ( preg_match( '/^(.+)-(\d+)$/', $id, $matches ) ) {
if ( preg_match( '/^(.+)-(\d+)\z/', $id, $matches ) ) {
$parsed['id_base'] = $matches[1];
$parsed['number'] = (int) $matches[2];
} else {
Expand Down
108 changes: 108 additions & 0 deletions tests/phpunit/tests/rest-api/rest-widgets-controller.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1137,6 +1137,51 @@ public function test_create_item_second_instance() {
);
}

/**
* @ticket 66434
*/
public function test_create_item_rejects_id_with_trailing_newline() {
$this->setup_widget(
'text',
1,
array(
'text' => 'Custom text test',
)
);
$this->setup_sidebar(
'sidebar-1',
array(
'name' => 'Test sidebar',
),
array( 'text-1' )
);
$this->setup_sidebar(
'sidebar-2',
array(
'name' => 'Test sidebar 2',
)
);

$request = new WP_REST_Request( 'POST', '/wp/v2/widgets' );
$request->set_body_params(
array(
'id' => "text-1\n",
'sidebar' => 'sidebar-2',
'instance' => array(
'raw' => array(
'text' => 'Updated text test',
),
),
)
);
$response = rest_get_server()->dispatch( $request );

$this->assertErrorResponse( 'rest_invalid_widget', $response, 400 );
$this->assertSame( 'Custom text test', get_option( 'widget_text' )[1]['text'] );
$this->assertSame( array( 'text-1' ), get_option( 'sidebars_widgets' )['sidebar-1'] );
$this->assertSame( array(), get_option( 'sidebars_widgets' )['sidebar-2'] );
}

/**
* @ticket 41683
*/
Expand Down Expand Up @@ -1415,6 +1460,69 @@ public function test_create_item_legacy_widget() {
);
}

/**
* @ticket 66434
*/
public function test_update_item_unknown_id_returns_404() {
$this->setup_sidebar(
'sidebar-1',
array(
'name' => 'Test sidebar',
)
);

$request = new WP_REST_Request( 'PUT', '/wp/v2/widgets/unknown-3' );
$request->set_body_params(
array(
'sidebar' => 'sidebar-1',
)
);
$response = rest_get_server()->dispatch( $request );

$this->assertErrorResponse( 'rest_widget_not_found', $response, 404 );
$this->assertSame( array(), get_option( 'sidebars_widgets' )['sidebar-1'] );
}

/**
* @ticket 66434
*/
public function test_update_item_rejects_id_with_trailing_newline() {
$this->setup_widget(
'text',
1,
array(
'text' => 'Custom text test',
)
);
$this->setup_sidebar(
'sidebar-1',
array(
'name' => 'Test sidebar',
),
array( 'text-1' )
);
$this->setup_sidebar(
'sidebar-2',
array(
'name' => 'Test sidebar 2',
)
);

$request = new WP_REST_Request( 'PUT', '/wp/v2/widgets/text-1' );
$request->set_body_params(
array(
'id' => "text-1\n",
'sidebar' => 'sidebar-2',
)
);
$response = rest_get_server()->dispatch( $request );

$this->assertErrorResponse( 'rest_widget_not_found', $response, 404 );
$this->assertSame( 'Custom text test', get_option( 'widget_text' )[1]['text'] );
$this->assertSame( array( 'text-1' ), get_option( 'sidebars_widgets' )['sidebar-1'] );
$this->assertSame( array(), get_option( 'sidebars_widgets' )['sidebar-2'] );
}

/**
* @ticket 41683
*/
Expand Down
10 changes: 10 additions & 0 deletions tests/phpunit/tests/widgets/wpParseWidgetId.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,14 @@ public function test_returns_only_id_base_without_number() {
wp_parse_widget_id( 'archives' )
);
}

/**
* @ticket 66434
*/
public function test_does_not_parse_number_before_trailing_newline() {
$this->assertSame(
array( 'id_base' => "text-2\n" ),
wp_parse_widget_id( "text-2\n" )
);
}
}
Loading