Skip to content

Globals Styles Endpoint: Declare edit_css capability in links #3889

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

Closed
Mamaduka wants to merge 2 commits into from
Closed

Globals Styles Endpoint: Declare edit_css capability in links #3889

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
189e281
Globals Styles Endpoint: Declare edit_css capability in links
Mamaduka Jan 22, 2023
73f1fd2
Add since 6.2.0 annotation to method.
hellofromtonya Jan 25, 2023
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
5 changes: 5 additions & 0 deletions src/wp-includes/rest-api/endpoints/class-wp-rest-global-styles-controller.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -431,6 +431,7 @@ protected function prepare_links( $id ) {
* Get the link relations available for the post and current user.
*
* @since 5.9.0
* @since 6.2.0 Added 'edit-css' action.
*
* @return array List of link relations.
*/
Expand All @@ -442,6 +443,10 @@ protected function get_available_actions() {
$rels[] = 'https://api.w.org/action-publish';
}

if ( current_user_can( 'edit_css' ) ) {
$rels[] = 'https://api.w.org/action-edit-css';
}
Comment on lines +446 to +448
Copy link
Contributor

@hellofromtonya hellofromtonya Jan 25, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's an unanswered question from the Gutenberg PR

I couldn't find documentation on how these URLs are generated/created. So I need to double-check if https://api.w.org/action-edit-css is the correct format.

Pinging @TimothyBJacobs @spacedmonkey for review.

Copy link
Member Author

@Mamaduka Mamaduka Jan 25, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All similar action URLs lead to a 404 page - https://api.wordpress.org/action-unfiltered-html.

Copy link
Member Author

@Mamaduka Mamaduka Jan 30, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@TimothyBJacobs, @spacedmonkey, can you confirm that it's okay to use this URL?

Copy link
Member

@TimothyBJacobs TimothyBJacobs Jan 31, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for missing this the first time round. The URLs don't actually point anywhere. That URL is fine to use.

Copy link
Member Author

@Mamaduka Mamaduka Jan 31, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, @TimothyBJacobs!


return $rels;
}

Expand Down
19 changes: 19 additions & 0 deletions tests/phpunit/tests/rest-api/rest-global-styles-controller.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -513,4 +513,23 @@ public function test_get_theme_items() {
);
$this->assertSameSetsWithIndex( $data, $expected );
}

/**
* @covers WP_REST_Global_Styles_Controller::get_available_actions
*/
public function test_assign_edit_css_action_admin() {
wp_set_current_user( self::$admin_id );

$request = new WP_REST_Request( 'GET', '/wp/v2/global-styles/' . self::$global_styles_id );
$request->set_param( 'context', 'edit' );
$response = rest_do_request( $request );
$links = $response->get_links();

// Admins can only edit css on single site.
if ( is_multisite() ) {
$this->assertArrayNotHasKey( 'https://api.w.org/action-edit-css', $links );
} else {
$this->assertArrayHasKey( 'https://api.w.org/action-edit-css', $links );
}
}
Comment on lines +520 to +534
Copy link
Member Author

@Mamaduka Mamaduka Jan 22, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I used the post-controller tests as a blueprint here https://github.com/WordPress/wordpress-develop/blob/6.1/tests/phpunit/tests/rest-api/rest-posts-controller.php#L4903-L4918.

Copy link
Contributor

@hellofromtonya hellofromtonya Feb 1, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good job @Mamaduka 👏

}