Add new registerInserterMediaCategory API to make media categories extensible
#51542
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
ntsekouras
added
[Feature] Inserter
4 tasks
ntsekouras
force-pushed
the
add/registerInserterMediaCategory-api
branch
from
4e66a1f
to
e542fed
Compare
ntsekouras
commented
Jun 15, 2023
| /** | ||
| * Interface for inserter media requests. | ||
| * | ||
| * @typedef {Object} InserterMediaRequest |
There was a problem hiding this comment.
What I need for docs is to export these type definitions(InserterMediaRequest, InserterMediaItem, InserterMediaCategoryLabels, InserterMediaCategory). Is there a standarized way to do that, that I'm not aware of?
Currently are docs formatter supports generating only one typedef in docs. So one way to go(if there is no standarized way) would be to augment or update our formatter to handle this use case. Another way would be to just add them as comments in the function's description, but I'd like to avoid the duplication of the types descriptions.
|
Size Change: +340 B (0%) Total Size: 1.43 MB
ℹ️ View Unchanged
|
draganescu
approved these changes
Jun 19, 2023
youknowriad
reviewed
Jun 19, 2023
|
I've been playing around with this and it works nicely 👍 |
ntsekouras
force-pushed
the
add/registerInserterMediaCategory-api
branch
from
e542fed
to
4abdad1
Compare
ntsekouras
requested review from
ajitbohra,
ryanwelcher,
juanmaguitar,
fabiankaegy and
ndiego
as code owners
|
I didn't test but the code looks good to me now. 👍 |
ntsekouras
force-pushed
the
add/registerInserterMediaCategory-api
branch
from
9f77dfd
to
b092365
Compare
|
Flaky tests detected in b092365. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/5353817841
|
sethrubenstein
pushed a commit
to pewresearch/gutenberg
that referenced
this pull request
Jul 13, 2023
…extensible (WordPress#51542) * Add new `registerInserterMediaCategory` API to make media categories extensible * make `registerInserterMediaCategory` an action * add tests * add docs
4 tasks
1 task
|
@ntsekouras, I'm sorry if this is not the best place for this, but I have a question: is it possible to use this functionality to add a list of images that come not from an external source, but from a theme or a plugin directory? I wonder if this would be a nice way to provide "Theme suggested assets" that are not uploaded to the media library but are not necessarily external to the server. |
10 tasks
Sorry for the delayed reply. Each category has to implement a |
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?
In #44918 and #46222 we added a new media tab in the inserter and integrated Openverse respectively. Currently the media categories are stored in a private block editor setting(
inserterMediaCategories), which means they are not extensible.This PR adds a new
blockEditoraction for registering additional media categories. The used setting is preserved as a private one, so extenders can only add new categories without having any control over the core media categories.Tasks
Testing Instructions
Run the below function in dev tools console and observe the new category in inserter's media tab. The example uses the Openverse category object and just updates the names used.