Skip to content

Conversation

@ramonjd
Copy link
Member

@ramonjd ramonjd commented Oct 30, 2024

What

Syncs WordPress/gutenberg#66541

For the Post Editor, preload '/wp/v2/global-styles/' . $global_styles_id with a context corresponding to user caps, that is, 'edit' for users that can edit global styles, and 'view' for everyone else.

Why

Preloading the global styles endpoint according to role context means that admins and non admins, e.g., editors, avoid unnecessary clientside requests.

Different clientside requests fire for each.

How?

Use current_user_can( 'edit_theme_options' ) to test for global styles edit caps. This matches post type caps.

Testing Instructions

  1. Create two users: one admin, another editor or other role that can edit posts.
  2. For each user, fire up this branch and head to the post editor.
  3. Check that global-styles endpoints aren't fetched client side, but are, rather, preloaded via rest_preload_api_request
  4. As admin, check the same for the site editor to make sure this patch does not cause any regressions there.

For admins in the POST and SITE editors the following URLS should be preloaded:

 "/wp/v2/global-styles/<id>"  - "OPTIONS"
"/wp/v2/global-styles/themes/twentytwentyfive?context=view"  - "GET"
"/wp/v2/global-styles/themes/twentytwentyfive/variations?context=view"  - "GET"
"/wp/v2/global-styles/<id>5?context=edit"  - "GET"

For editors in the POST editor:

"/wp/v2/global-styles/<id>"  - "OPTIONS"
"/wp/v2/global-styles/themes/twentytwentyfive?context=view"  - "GET"
"/wp/v2/global-styles/themes/twentytwentyfive/variations?context=view"  - "GET"
"/wp/v2/global-styles/<id>?context=view"  - "GET"

Trac ticket: https://core.trac.wordpress.org/ticket/62322


This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

…ontext corresponding to user caps, that is, edit for users that can edit global styles, and view for everyone else.

Preloading the global styles endpoint according to role context means that admins and non admins, e.g., editors, avoid clientside requests.
@ramonjd ramonjd self-assigned this Oct 30, 2024
@github-actions
Copy link

github-actions bot commented Oct 30, 2024

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props ramonopoly, peterwilsoncc.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@github-actions
Copy link

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

  • The Plugin and Theme Directories cannot be accessed within Playground.
  • All changes will be lost when closing a tab with a Playground instance.
  • All changes will be lost when refreshing the page.
  • A fresh instance is created each time the link below is clicked.
  • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
    it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

Copy link
Contributor

@peterwilsoncc peterwilsoncc left a comment

Choose a reason for hiding this comment

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

Looks good to me.

As an author, the global styles were loaded via a request on trunk; on this branch they are not.

@github-actions
Copy link

A commit was made that fixes the Trac ticket referenced in the description of this pull request.

SVN changeset: 59795
GitHub commit: c278311

This PR will be closed, but please confirm the accuracy of this and reopen if there is more work to be done.

@github-actions github-actions bot closed this Feb 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants