REST API: Adds the site reading options to the index #69106
+47
−47
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Mamaduka
added
REST API Interaction
|
Size Change: -9 B (0%) Total Size: 1.84 MB
ℹ️ View Unchanged
|
|
Flaky tests detected in dead145. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/13214441706
|
Mamaduka
force-pushed
the
add/rest-index-reading-options
branch
from
dead145 to
0fca1cc
Compare
|
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 If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
Mamaduka
requested review from
youknowriad,
carolinan,
jorgefilipecosta,
fabiankaegy and
t-hamano
Mamaduka
commented
Feb 11, 2025
Comment on lines
+47
to
+48
| // Seems to be coming from `enableComplementaryArea`. | ||
| '/wp/v2/users/me', |
There was a problem hiding this comment.
Had to change the order here. Now that getTemplateId uses the REST index, the settings request is triggered a bit later.
This was referenced Feb 13, 2025
|
George asked me to opine on this ticket while we were discussing another issue. I don't think this data belongs on the index as it's not something that's needed for ingesting or using the API in a logged out state. I acknowledge all of this is low risk ( I agree it would be good to have the data available for theme editors without options access, so ideally the data will go on a authenticated endpoint in a read-only format. |
The value does seem useful to me publicly. If I want to programatically link to their posts page, I think reading that value would be the best way to do it?
If this were in some other endpoint, what caps check would guard it? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
Closes #68870.
PR exposes the site reading settings via the REST index, which allows low-capability users to preview and change templates.
Why?
The
/settingsendpoint requires themanage_optionscapability to access the site settings and does not have a mechanism forreadonlythe settings.Until #48885 is resolved, the only option for exposing
readonlysettings is the REST API index.How
Use
getEntityRecord( state, 'root', '__unstableBase' )to access newreadonlysettings.Note
I've not touched other places where these settings are used because it's not a matter of simple search and replace.
While not an issue for non-administrator users, some components also need to account for edited settings. Currently, that's impossible with
getEntityRecord( state, 'root', '__unstableBase' ).Testing Instructions
P.S. You might see 403 requests for the Navigation block. That needs to be handled separately.
Testing Instructions for Keyboard
Same.
Screenshots or screencast