Plugin sorting via priority property in registerPlugin #16384

ryanwelcher · 2019-07-02T02:00:04Z

Description

As is stands now, there is no way to control the order of the items being rendered in Slots. This PR adds a new priority property to the settings object that is passed to registerPlugin. This property is optional and has a default value of 10. I chose 10 as that is the default priority for Hooks and familiar to most WordPress developers and so that we can move items ahead of the default position without using negative numbers.

The approach adds the priority property when the plugin is being registered and then uses sortBy to sort the plugins before they are rendered inside the <PluginArea /> component.

How has this been tested?

This has been tested locally and using the unit and e2e tests.

Types of changes

New feature (non-breaking change which adds functionality)

Checklist:

My code is tested.
My code follows the WordPress code style.
My code follows the accessibility standards.
My code has proper inline documentation.
I've included developer documentation if appropriate.

ryanwelcher · 2019-07-02T02:02:09Z

This was broken out based on comments from @youknowriad on #13361

packages/plugins/src/api/index.js

packages/plugins/src/components/plugin-area/index.js

ryanwelcher · 2019-08-26T14:32:18Z

@youknowriad have you had a chance to think on this any further? Happy to make any changes as needed.

paaljoachim · 2019-09-11T15:05:47Z

Adding in what @youknowriad mentioned during the core editor meeting on the 11th September:
"To be honest, I'm not entirely sold on this because it's very tied to the implementation of the Slot. (not a fully semantic API).
I don't have a better alternative at the moment.
I know @matias have some thoughts about that as well."

ryanwelcher · 2019-10-22T15:52:07Z

Based on comments in the last #core-editor meeting, I feel I need to better explain this PR. I have created a new issue #18064 to track the intent.

@mcsf commented:

It seems that priority and order are very visually focused, in stark contrast with how Gutenberg has tried to use SlotFill so far.

The items that would be affected by this change are very much visually based. They appear in a certain locations of the admin - ie. Menu Items and sidebar panels

In Gutenberg, we talk about advanced settings, inspector, etc., instead of the visual element sidebar. Coming back to priority, what does it mean for SlotFill as far as selective rendering goes? how is a sequence determined semantically? etc.Why does this matter? Well, the bridging of different platforms and environments under Gutenberg is an important factor. If a codebase needs to work transparently across Web and Mobile, for example, its semantics needs to be clear and independent of a particular visual expression (e.g. Web on Desktop)

I want to make it clear, that this PR does not affect how a SlotFill is rendered and it doesn't interact with the SlotFill system in any way. It simply controls the order in which plugins( that contain SlotFIlls ) are rendered inside the PluginAreacomponent.

ItsJonQ · 2019-10-28T20:49:18Z

@ryanwelcher Hallo!! I just took a peak at this PR.

I think the priority approach is interesting idea, and your solution was well done! Nice, simple, and clean 😎 .

Note: I don't have context from the previous JS meetings.

Coming into this, I was curious how this would play out once more and more custom blocks are registered.

I think when you have your own blocks, you have (basically) maximum control on ordering. But when you have a collection of blocks from other people, you have far less control.

When something like priority is enabled, then block creators can just make their plugins priority 99999 for top spot. (Kinda like what happens in the world of CSS, with z-index: 999999999; 😂 ).

I'm not sure how they're sorted by now...

The only sort order I can think of that makes sense (given the above scenario) would be alphabetical.

That said, I'm not against this idea! Just wanted to share my thoughts :)

From the WordPress PHP side, there's wp_enqueue_scripts, which does a very similar thing. But it runs into the whole "plz make my scripts highest priority" problem, at least from my experience and from examples I found online:

https://wordpress.stackexchange.com/questions/272067/how-to-enqueue-scripts-in-order-of-head-section

ryanwelcher · 2019-10-29T13:00:56Z

Hi, @ItsJonQ!

Thanks for taking the time to review the PR. All input is greatly appreciated here 😄 . I just wanted to address some of your comments/concerns.

When something like priority is enabled, then block creators can just make their plugins priority 99999 for top spot. (Kinda like what happens in the world of CSS, with z-index: 999999999; 😂 ).

Unfortunately, this is going to be inherent with this approach. Authors can abuse this option but they can do similar things now in the Hooks API which also uses the concept of priority to control the order in which hook callbacks are run.

I'm not sure how they're sorted by now...

There is no sorting now at all. It is based on the order in which the code is loaded. This PR is meant to provide some control here.

The only sort order I can think of that makes sense (given the above scenario) would be alphabetical.

To your point above, authors can simply register a plugin called aaaaaaaaaaaaa-awesome-plugin to push it to the top of the rendering pile.

From the WordPress PHP side, there's wp_enqueue_scripts, which does a very similar thing. But it runs into the whole "plz make my scripts highest priority" problem, at least from my experience and from examples I found online:

I understand your point here but that link above has more to do with how order is used when it comes to dependencies. The PR isn't meant to address that. If there are plugins that rely on each other, that should be addressed in a different way.

packages/edit-post/src/components/sidebar/plugin-sidebar/index.js

packages/plugins/src/api/index.js

gziolo · 2019-10-29T13:09:41Z

packages/plugins/src/components/plugin-area/index.js

@@ -58,16 +59,22 @@ class PluginArea extends Component {
 	}

 	getCurrentPluginsState() {
-		return {
-			plugins: map( getPlugins(), ( { icon, name, render } ) => {
+		const plugins = compose(


It would be great to have a test which validates whether components are rendered in the order enforced by priorities.

Sounds great! I'll get those in place ASAP.

packages/plugins/src/components/plugin-context/index.js

ryanwelcher · 2020-01-07T17:12:30Z

Related #19485

ndiego · 2024-01-01T18:37:12Z

Does anyone know if there's a workaround for this?

Not that I am aware of.

…orts the registered plugins by priority before rendering them in PluginArea

github-actions · 2024-08-27T15:35:49Z

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.

Unlinked Accounts

The following contributors have not linked their GitHub and WordPress.org accounts: @[email protected], @nicolad, @ItsJonQ, @etoledom, @michaelmcandrew.

Contributors, please read how to link your accounts to ensure your work is properly credited in WordPress releases.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Unlinked contributors: [email protected], nicolad, ItsJonQ, etoledom, michaelmcandrew.

Co-authored-by: swissspidy <[email protected]>
Co-authored-by: ryanwelcher <[email protected]>
Co-authored-by: gziolo <[email protected]>
Co-authored-by: paaljoachim <[email protected]>
Co-authored-by: nerrad <[email protected]>
Co-authored-by: adamsilverstein <[email protected]>
Co-authored-by: mcsf <[email protected]>
Co-authored-by: jeffpaul <[email protected]>
Co-authored-by: SiobhyB <[email protected]>
Co-authored-by: ndiego <[email protected]>
Co-authored-by: emeaguiar <[email protected]>

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

ryanwelcher requested review from adamsilverstein, aduth, gziolo, talldan and youknowriad as code owners July 2, 2019 02:00

ryanwelcher mentioned this pull request Jul 2, 2019

Introduces PluginSettingsSidebar slotfill to the Document sidebar. #13361

Merged

5 tasks

nicolad reviewed Jul 2, 2019

View reviewed changes

packages/plugins/src/api/index.js Outdated Show resolved Hide resolved

nicolad reviewed Jul 2, 2019

View reviewed changes

packages/plugins/src/components/plugin-area/index.js Outdated Show resolved Hide resolved

nicolad assigned ryanwelcher Jul 2, 2019

ryanwelcher added the [Feature] Extensibility The ability to extend blocks or the editing experience label Aug 27, 2019

ryanwelcher requested review from nicolad and swissspidy August 27, 2019 19:21

ryanwelcher force-pushed the try/slot-fill-priority branch 2 times, most recently from 31be67b to 247a1a2 Compare September 6, 2019 17:20

ryanwelcher changed the title ~~SlotFill sorting with a priority property~~ Plugin sorting via priority property in registerPlugin Oct 22, 2019

ryanwelcher mentioned this pull request Oct 22, 2019

Provide way to control render order of plugins registered via registerPlugin #18064

Open

gziolo added the [Feature] Plugins API Extending the Gutenberg project with plugins via the Plugins API label Oct 23, 2019

mcsf mentioned this pull request Oct 28, 2019

Mobile components are diverging too much #18018

Open

gziolo reviewed Oct 29, 2019

View reviewed changes

ryanwelcher mentioned this pull request Jan 7, 2020

Introduce PluginManager class #19485

Open

5 tasks

ryanwelcher requested review from ajitbohra, atimmer and chrisvanpatten as code owners January 7, 2020 17:22

ndiego mentioned this pull request Jan 16, 2024

Move location of Visibility Panel? ndiego/block-visibility#93

Open

Ryan Welcher added 25 commits August 27, 2024 11:29

Adds priority to context

0e55e10

Adds priority property to the settings object with a default of 10. S…

578e6d7

…orts the registered plugins by priority before rendering them in PluginArea

Adds better data validation and new unit tests

927b0a1

using compose to sort the plugins

8b9f3f1

Adds priority to context

a1891d8

Adds priority property to the settings object with a default of 10. S…

b82dc0a

…orts the registered plugins by priority before rendering them in PluginArea

Adds better data validation and new unit tests

46cab70

using compose to sort the plugins

a093810

Use Number.isInteger() instead to check the priority

055d60b

Adds 10 as the default priority

0a16462

Remove priority from plugin-sidebar implementation

4b388f9

Adds priority to context

53e2588

Adds priority property to the settings object with a default of 10. S…

8a87daa

…orts the registered plugins by priority before rendering them in PluginArea

Adds better data validation and new unit tests

5efbdd7

using compose to sort the plugins

fec9df9

Adds priority to context

62d9591

Adds priority property to the settings object with a default of 10. S…

2fd2c1d

…orts the registered plugins by priority before rendering them in PluginArea

Adds better data validation and new unit tests

f429005

using compose to sort the plugins

b98384c

Use Number.isInteger() instead to check the priority

3eb81d5

Adds 10 as the default priority

6dc9022

Remove priority from plugin-sidebar implementation

21b220d

Adding missed test file

a16f0f5

Add correct sorting.

43f9368

Update docs.

e590e69

ryanwelcher force-pushed the try/slot-fill-priority branch from 56c536b to e590e69 Compare August 27, 2024 15:35

justintadlock mentioned this pull request Aug 27, 2024

Tracking: A curated list of high-priority extensibility issues and enhancements #64848

Open

24 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Plugin sorting via priority property in registerPlugin #16384

Plugin sorting via priority property in registerPlugin #16384

ryanwelcher commented Jul 2, 2019 •

edited

Loading

ryanwelcher commented Jul 2, 2019 •

edited

Loading

ryanwelcher commented Aug 26, 2019

paaljoachim commented Sep 11, 2019

ryanwelcher commented Oct 22, 2019 •

edited

Loading

ItsJonQ commented Oct 28, 2019

ryanwelcher commented Oct 29, 2019

gziolo Oct 29, 2019

ryanwelcher Nov 3, 2019

ryanwelcher commented Jan 7, 2020

ndiego commented Jan 1, 2024

github-actions bot commented Aug 27, 2024

Plugin sorting via priority property in registerPlugin #16384

Are you sure you want to change the base?

Plugin sorting via priority property in registerPlugin #16384

Conversation

ryanwelcher commented Jul 2, 2019 • edited Loading

Description

How has this been tested?

Types of changes

Checklist:

ryanwelcher commented Jul 2, 2019 • edited Loading

ryanwelcher commented Aug 26, 2019

paaljoachim commented Sep 11, 2019

ryanwelcher commented Oct 22, 2019 • edited Loading

ItsJonQ commented Oct 28, 2019

ryanwelcher commented Oct 29, 2019

gziolo Oct 29, 2019

Choose a reason for hiding this comment

ryanwelcher Nov 3, 2019

Choose a reason for hiding this comment

ryanwelcher commented Jan 7, 2020

ndiego commented Jan 1, 2024

github-actions bot commented Aug 27, 2024

Unlinked Accounts

ryanwelcher commented Jul 2, 2019 •

edited

Loading

ryanwelcher commented Jul 2, 2019 •

edited

Loading

ryanwelcher commented Oct 22, 2019 •

edited

Loading