Iterate on Legacy Widget block #29960
Merged
Conversation
This file contains hidden or 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
noisysocks
added
[Block] Legacy Widget
|
Size Change: -1.69 kB (0%) Total Size: 1.41 MB
ℹ️ View Unchanged
|
draganescu
reviewed
Mar 18, 2021
draganescu
reviewed
Mar 18, 2021
draganescu
reviewed
Mar 18, 2021
noisysocks
force-pushed
the
try/rewrite-legacy-widget-block
branch
from
c629341 to
6d98741
Compare
noisysocks
force-pushed
the
try/rewrite-legacy-widget-block
branch
2 times, most recently
from
c361ca4 to
bb5878e
Compare
noisysocks
commented
Mar 23, 2021
Member
Author
|
I need to test this some more, elaborate on the dot points in the PR's description, and write some documentation, but this should be ready for an initial "broad stroke" review. |
kevin940726
reviewed
Mar 24, 2021
Member
kevin940726
left a comment
kevin940726
left a comment
There was a problem hiding this comment.
Excellent work!
I'm still playing with it. Just some code smell and nitpicking for now.
packages/block-library/src/legacy-widget/edit/widget-type-selector.js
Outdated
Show resolved
Hide resolved
Rewrites the Legacy Widget block with a view to: - Handle instance attributes that can't be serialised into JSON. - Remove unnecessary block attributes. There is now only `id`, `idBase` and `instance`. - Improve how widgets that don't extend WP_Widget are handled. These are now manually saved and their data is completely seperate to the block editor. - Make the block use @wordpress/core-data APIs instead of relying on @wordpress/edit-post. This makes it possible to use the block in the Customizer, and, perhaps in the future, the site editor and post editor. - Use hooks instead of class components.
Co-authored-by: Kai Hao <[email protected]>
Co-authored-by: Kai Hao <[email protected]>
Co-authored-by: Kai Hao <[email protected]>
Co-authored-by: Kai Hao <[email protected]>
noisysocks
force-pushed
the
try/rewrite-legacy-widget-block
branch
from
285ebaf to
4ddf54e
Compare
noisysocks
force-pushed
the
try/rewrite-legacy-widget-block
branch
from
4ddf54e to
c2ec483
Compare
noisysocks
requested review from
TimothyBJacobs,
ellatrix,
nerrad,
spacedmonkey,
talldan and
tellthemachines
as code owners
noisysocks
changed the title
Member
Author
|
This should be ready now 🙂 |
This was referenced Mar 26, 2021
7 tasks
7 tasks
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 this is
Rewrites the Legacy Widget block with a view to:
1) Handle instance attributes that can't be serialised into JSON. See #28902.
This is done by sending user input to the REST API which will return the instance serialized as a base64 string. The serialized data is stored in the block's
instance.encodedattribute along with a hash ininstance.hash.The complete flow of how this works is detailed in #28902 (comment).
2) Remove unnecessary block attributes. There is now only
id,idBaseandinstance.Attributes such as
number,widget_classandclassnameare not necessary to store in the block editor. Widgets that extendWP_Widgetare now represented usingidBaseandinstance. Widgets that do not extendWP_Widgetare represented usingid.See
legacy-widget/README.mda lengthier explanation.3) Improve how widgets that don't extend
WP_Widgetare handled. These are now manually saved and their data is completely seperate to the block editor.Widgets that do not extend
WP_Widgetare treated as a dumb<form>. We cannot assume anything about this kind of widgets, and so no data is stored in the block editor.See
legacy-widget/README.mda lengthier explanation.4) Make the block use
@wordpress/core-dataAPIs instead of relying on@wordpress/edit-post. This makes it possible to use the block in the Customizer. See #28618 (comment).Note that while the Legacy Widget block is now fully functional when used in the post editor or site editor, I have disabled it in these contexts. We can enable it if/when we are sure that we want to maintain support for this into the future.
5) Use hooks instead of class components.
This reduces the amount of boilerplate and makes things simpler (I think) to understand.
What to test
The only user visible changes are in the Appearance → Widgets screen, so please test adding, editing, saving, and removing Legacy Widgets here.
You can test the Core widgets by adding this line e.g. to
gutenberg.php:You can test a non-
WP_Widgetby adding this code e.g. togutenberg.php:https://gist.github.com/noisysocks/c9e20ef813d3b17a15da7e6d5bc8f611#file-marquee-php
Follow up tasks
class_namefrom the REST API. This property is deprecated.ServerSideRenderfor the Preview tab.