Add preload_paths filter for widgets screen and full site editing #28701

manooweb · 2021-02-03T18:32:18Z

Description

This PR propose to fix #28690 by adding a filter for widgets screen and full site editing features to be able to preloading datas before the pages is loaded.

Edit: I've just updated this PR and the issue with a comment because I saw I had forgotten the navigation editor.

gziolo · 2021-02-04T10:57:47Z

Thank you for working on it. It feels like it's about time to abstract this editor setup to avoid code duplication but, more importantly, to prevent this type of issue.

manooweb · 2021-02-04T11:09:17Z

Thanks!
Sure! Maybe Gutenberg itself could be use a filter because the paths couldn't be the same in function of the context (editor, widgets-editor...)
However, it also depends on how it will be merged later in the WordPress core.

gziolo · 2021-02-04T12:02:30Z

We could always have someting like:

initialize_block_editor( array(
    'preload_paths' => array(
        // data
    ),
    // more shared settings
) );

Edit: I see there is gutenberg_get_common_block_editor_settings already that is a good start.

talldan · 2021-02-05T03:33:54Z

Thanks for working on this. Also related is #24642.

edit: I realise this doesn't add any paths for the navigation editor, just the preloading mechanism, so it doesn't actually resolve the above issue.

manooweb · 2021-02-05T10:49:27Z

Thanks for working on this. Also related is #24642.

edit: I realise this doesn't add any paths for the navigation editor, just the preloading mechanism, so it doesn't actually resolve the above issue.

Yes! for the navigation editor there was nothing when I worked so I had to implement just the preloading mechanism.
So I can continue to work on this PR:

to add preload paths suggested in Navigation: Preload API requests #24642
improve this part of code to make it common between editors as suggest @gziolo

Let me know.

manooweb · 2021-02-05T11:03:43Z

We could always have someting like:
initialize_block_editor( array(
    'preload_paths' => array(
        // data
    ),
    // more shared settings
) );
Edit: I see there is gutenberg_get_common_block_editor_settings already that is a good start.

@gziolo we agree for the block editor, this is the responsability of WordPress core now ?
See https://github.com/WordPress/WordPress/blob/5.6.1/wp-admin/edit-form-blocks.php#L46-L83

The work in progress here could be also merged in WordPress core in a future release, right ?

oandregal · 2021-02-05T11:18:05Z

lib/navigation-page.php

+	// most of these are copied from edit-forms-blocks.php.
+	$preload_paths = array();
+
+	$preload_paths = apply_filters( 'navigation_editor_preload_paths', $preload_paths );


For the navigation screen, I see that there was an attempt to preload certain requests in #24672 (comment) but it didn't work well with the kind of entities managed by the navigation menu.

It looks to me that this PR could land without this part, which can be iterated later if/when we figure how to preload things for this editor.

gziolo · 2021-02-05T11:19:09Z

We can have a follow-up PR with a new method that would get proposed to the core just after it lands in Gutenberg. That means your assumption is all correct.

manooweb · 2021-02-16T10:08:24Z

As suggested by @gziolo #28701 (comment) I propose a modification to initialize each block-based editor the same way.

So I added the gutenberg_initialize_editor() function in editor-settings.php to put all is common for each of the editors including a filter for preload_paths.

I didn't deal with post block editor because, it seems to me that it isn't similar than the other, especially because of the way it is initialized:

its name is block_editor in preload_paths filter name and editor in the initialize function parameter
See https://github.com/WordPress/WordPress/blob/5.6.1/wp-admin/edit-form-blocks.php#L70
and https://github.com/WordPress/WordPress/blob/5.6.1/wp-admin/edit-form-blocks.php#L421
there is more than one parameter to initialize the post block editor
See https://github.com/WordPress/WordPress/blob/5.6.1/wp-admin/edit-form-blocks.php#L421 too
block_editor_preload_paths filter expect a second parameter: WP_Post $post
See https://github.com/WordPress/WordPress/blob/5.6.2/wp-admin/edit-form-blocks.php#L70

I think we can add some other parameters passed to the new gutenberg_initialize_editor() function to be able to specialize more its code to the post block editor need.

For information, I confirm that the preload_paths filter is a real need for us as I described in the initial #28690 issue.

manooweb · 2021-03-08T17:35:52Z

I rebased on trunk and corrected gutenberg_initialize_editor() documentation to respect coding standards which previously broke the PHP lint check job.

manooweb · 2021-03-09T06:30:40Z

This PR only modify PHP code and doesn't touch anything about React Native.
Is there something I can do with React Native E2E Tests (Android) which break or is there just a problem on CI environment ?

gziolo · 2021-03-09T06:36:01Z

This PR only modify PHP code and doesn't touch anything about React Native.
Is there something I can do with React Native E2E Tests (Android) which break or is there just a problem on CI environment ?

It looks like a general issue with the CI job. I see the same failure on trunk branch. I asked on WordPress Slack in #mobile channel for clarification (link requires registration at https://make.wordpress.org/chat/):
https://wordpress.slack.com/archives/C02RQC4LY/p1615271529010900

hypest · 2021-03-09T09:56:45Z

👋 all.

I see the same failure on trunk branch

Hey @gziolo , looking at the logs it looks like the fail here (timing out trying to load some gradle cache) was different than the ones on trunk (Cannot read property 'stopDriver' of undefined on a gallery block test).

I restarted the job here since it looks like an intermediate CI infra issue. We can investigate more if it persists with the same error. Sorry for the inconvenience!

lib/editor-settings.php

…}_preload_paths filter name

…nitialize_editor() function

manooweb · 2021-03-09T18:14:00Z

Pushed again by taking in account the latest @swissspidy review comments. Thanks 😉

draganescu

This tests well, and the code is a nice refactoring removing useless duplication, while also allowing for customizable preload_paths. From me,

gziolo · 2021-03-12T06:22:03Z

Awesome work @manooweb, this is a great start towards unifying the way block editor is initialized on all pages 👍🏻

manooweb · 2021-03-12T10:43:09Z

Thank you for merging 👍 and your encouragement ☺

gziolo · 2021-03-24T11:46:35Z

I started looking into bringing this new helper into WordPress core. It looks like it might be quite a journey, see WordPress/wordpress-develop#1118 :)

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

manooweb requested review from spacedmonkey and TimothyBJacobs as code owners February 3, 2021 18:32

gziolo added the [Feature] Extensibility The ability to extend blocks or the editing experience label Feb 3, 2021

gziolo requested a review from a team February 4, 2021 10:50

gziolo requested a review from oandregal February 4, 2021 12:04

talldan added [Feature] Full Site Editing [Feature] Widgets Screen The block-based screen that replaced widgets.php. [Type] Enhancement A suggestion for improvement. labels Feb 5, 2021

oandregal reviewed Feb 5, 2021

View reviewed changes

gziolo requested review from youknowriad, noisysocks and talldan February 16, 2021 09:43

draganescu mentioned this pull request Feb 18, 2021

Navigation Editor Tracking Issue #29102

Closed

62 tasks

Base automatically changed from master to trunk March 1, 2021 15:45

Fix function documentation coding standards

168d1eb

manooweb force-pushed the master branch from 2ff5c6d to 168d1eb Compare March 8, 2021 16:55

gziolo requested review from aristath, mtias, mcsf and a team March 8, 2021 18:15

swissspidy reviewed Mar 9, 2021

View reviewed changes

lib/editor-settings.php Outdated Show resolved Hide resolved

swissspidy reviewed Mar 9, 2021

View reviewed changes

lib/editor-settings.php Outdated Show resolved Hide resolved

manooweb added 4 commits March 9, 2021 18:24

Define a $editor_name local variable for readibiilty in {$editor_name…

fbd59c0

…}_preload_paths filter name

Add {$editor_name}_preload_paths filter documentation

e52cafd

Make $editor_name and $editor_script_handle parameters of gutenberg_i…

30deb86

…nitialize_editor() function

Replace gutenberg_initialize_editor() calls with its new parameters

5edacbd

draganescu approved these changes Mar 11, 2021

View reviewed changes

draganescu merged commit e6d3f29 into WordPress:trunk Mar 11, 2021

github-actions bot added this to the Gutenberg 10.3 milestone Mar 11, 2021

dependabot bot mentioned this pull request Mar 12, 2021

Bump gutenberg from e4eb4be to 27cb4f6 dcalhoun/gutenberg-mobile#181

Closed

dependabot bot mentioned this pull request Mar 12, 2021

Bump gutenberg from 7f7910f to 27cb4f6 fluiddot/gutenberg-mobile#119

Closed

gziolo mentioned this pull request Mar 24, 2021

Editor: Abstract block editor configuration WordPress/wordpress-develop#1118

Closed

manooweb deleted the master branch April 8, 2021 16:40

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add preload_paths filter for widgets screen and full site editing #28701

Add preload_paths filter for widgets screen and full site editing #28701

manooweb commented Feb 3, 2021 •

edited

Loading

gziolo commented Feb 4, 2021

manooweb commented Feb 4, 2021

gziolo commented Feb 4, 2021 •

edited

Loading

talldan commented Feb 5, 2021 •

edited

Loading

manooweb commented Feb 5, 2021

manooweb commented Feb 5, 2021

oandregal Feb 5, 2021

gziolo commented Feb 5, 2021

manooweb commented Feb 16, 2021 •

edited

Loading

manooweb commented Mar 8, 2021 •

edited

Loading

manooweb commented Mar 9, 2021

gziolo commented Mar 9, 2021

hypest commented Mar 9, 2021

manooweb commented Mar 9, 2021

draganescu left a comment

gziolo commented Mar 12, 2021

manooweb commented Mar 12, 2021

gziolo commented Mar 24, 2021 •

edited

Loading

Add preload_paths filter for widgets screen and full site editing #28701

Add preload_paths filter for widgets screen and full site editing #28701

Conversation

manooweb commented Feb 3, 2021 • edited Loading

Description

gziolo commented Feb 4, 2021

manooweb commented Feb 4, 2021

gziolo commented Feb 4, 2021 • edited Loading

talldan commented Feb 5, 2021 • edited Loading

manooweb commented Feb 5, 2021

manooweb commented Feb 5, 2021

oandregal Feb 5, 2021

Choose a reason for hiding this comment

gziolo commented Feb 5, 2021

manooweb commented Feb 16, 2021 • edited Loading

manooweb commented Mar 8, 2021 • edited Loading

manooweb commented Mar 9, 2021

gziolo commented Mar 9, 2021

hypest commented Mar 9, 2021

manooweb commented Mar 9, 2021

draganescu left a comment

Choose a reason for hiding this comment

gziolo commented Mar 12, 2021

manooweb commented Mar 12, 2021

gziolo commented Mar 24, 2021 • edited Loading

manooweb commented Feb 3, 2021 •

edited

Loading

gziolo commented Feb 4, 2021 •

edited

Loading

talldan commented Feb 5, 2021 •

edited

Loading

manooweb commented Feb 16, 2021 •

edited

Loading

manooweb commented Mar 8, 2021 •

edited

Loading

gziolo commented Mar 24, 2021 •

edited

Loading