Image: Add the ability for a plugin to disable Image Editor #23966

mkaz · 2020-07-15T17:59:18Z

Description

This adds the ability for a plugin to disable the new Image Editor tools, so if it is a feature they do not want to offer, or does not work then it can be disabled programmatically.

Uses the block-editor settings store to disable.

How has this been tested?

Apply PR and confirm no change, everything works as expected (default does nothing different)
Try disabling, add a simple plugin that includes something like the following and confirm the new image editing tools are disable as expected. Additionally confirm other image features still work as expected.

add_filter( 'block_editor_settings', function( $settings ) {
	$settings['imageEditing'] = false;
	return $settings;
} );

Types of changes

Disables Image Editing tools by checking if block-editor settings has been set to false.

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.

github-actions · 2020-07-15T18:16:25Z

Size Change: +690 B (0%)

Total Size: 1.15 MB

Filename	Size	Change
`build/block-editor/index.min.js`	125 kB	+646 B (0%)
`build/block-library/index.min.js`	132 kB	-78 B (0%)
`build/editor/index.min.js`	45.2 kB	+122 B (0%)

ℹ️ View Unchanged

Filename	Size	Change
`build/a11y/index.min.js`	1.14 kB	0 B
`build/annotations/index.min.js`	3.67 kB	0 B
`build/api-fetch/index.min.js`	3.43 kB	0 B
`build/autop/index.min.js`	2.82 kB	0 B
`build/blob/index.min.js`	620 B	0 B
`build/block-directory/index.min.js`	7.63 kB	0 B
`build/block-directory/style-rtl.css`	944 B	0 B
`build/block-directory/style.css`	945 B	0 B
`build/block-editor/style-rtl.css`	10.8 kB	0 B
`build/block-editor/style.css`	10.8 kB	0 B
`build/block-library/editor-rtl.css`	7.58 kB	0 B
`build/block-library/editor.css`	7.57 kB	0 B
`build/block-library/style-rtl.css`	7.77 kB	0 B
`build/block-library/style.css`	7.77 kB	0 B
`build/block-library/theme-rtl.css`	728 B	0 B
`build/block-library/theme.css`	729 B	0 B
`build/block-serialization-default-parser/index.min.js`	1.88 kB	0 B
`build/block-serialization-spec-parser/index.min.js`	3.1 kB	0 B
`build/blocks/index.min.js`	48.3 kB	0 B
`build/components/index.min.js`	200 kB	0 B
`build/components/style-rtl.css`	15.6 kB	0 B
`build/components/style.css`	15.6 kB	0 B
`build/compose/index.min.js`	9.67 kB	0 B
`build/core-data/index.min.js`	11.5 kB	0 B
`build/data-controls/index.min.js`	1.29 kB	0 B
`build/data/index.min.js`	8.45 kB	0 B
`build/date/index.min.js`	5.38 kB	0 B
`build/deprecated/index.min.js`	772 B	0 B
`build/dom-ready/index.min.js`	568 B	0 B
`build/dom/index.min.js`	3.23 kB	0 B
`build/edit-navigation/index.min.js`	10.8 kB	0 B
`build/edit-navigation/style-rtl.css`	1.08 kB	0 B
`build/edit-navigation/style.css`	1.08 kB	0 B
`build/edit-post/index.min.js`	304 kB	0 B
`build/edit-post/style-rtl.css`	5.61 kB	0 B
`build/edit-post/style.css`	5.61 kB	0 B
`build/edit-site/index.min.js`	16.8 kB	0 B
`build/edit-site/style-rtl.css`	3.06 kB	0 B
`build/edit-site/style.css`	3.06 kB	0 B
`build/edit-widgets/index.min.js`	9.35 kB	0 B
`build/edit-widgets/style-rtl.css`	2.45 kB	0 B
`build/edit-widgets/style.css`	2.45 kB	0 B
`build/editor/editor-styles-rtl.css`	537 B	0 B
`build/editor/editor-styles.css`	539 B	0 B
`build/editor/style-rtl.css`	3.78 kB	0 B
`build/editor/style.css`	3.78 kB	0 B
`build/element/index.min.js`	4.65 kB	0 B
`build/escape-html/index.min.js`	733 B	0 B
`build/format-library/index.min.js`	7.72 kB	0 B
`build/format-library/style-rtl.css`	547 B	0 B
`build/format-library/style.css`	548 B	0 B
`build/hooks/index.min.js`	2.13 kB	0 B
`build/html-entities/index.min.js`	621 B	0 B
`build/i18n/index.min.js`	3.56 kB	0 B
`build/is-shallow-equal/index.min.js`	711 B	0 B
`build/keyboard-shortcuts/index.min.js`	2.51 kB	0 B
`build/keycodes/index.min.js`	1.94 kB	0 B
`build/list-reusable-blocks/index.min.js`	3.12 kB	0 B
`build/list-reusable-blocks/style-rtl.css`	476 B	0 B
`build/list-reusable-blocks/style.css`	476 B	0 B
`build/media-utils/index.min.js`	5.32 kB	0 B
`build/notices/index.min.js`	1.79 kB	0 B
`build/nux/index.min.js`	3.4 kB	0 B
`build/nux/style-rtl.css`	671 B	0 B
`build/nux/style.css`	668 B	0 B
`build/plugins/index.min.js`	2.56 kB	0 B
`build/primitives/index.min.js`	1.4 kB	0 B
`build/priority-queue/index.min.js`	789 B	0 B
`build/redux-routine/index.min.js`	2.85 kB	0 B
`build/rich-text/index.min.js`	13.9 kB	0 B
`build/server-side-render/index.min.js`	2.71 kB	0 B
`build/shortcode/index.min.js`	1.7 kB	0 B
`build/token-list/index.min.js`	1.27 kB	0 B
`build/url/index.min.js`	4.06 kB	0 B
`build/viewport/index.min.js`	1.85 kB	0 B
`build/warning/index.min.js`	1.14 kB	0 B
`build/wordcount/index.min.js`	1.17 kB	0 B

_{compressed-size-action}

sirreal · 2020-07-16T13:55:02Z

Adding variables to the global (window) concerns me. This seems like a slippery slope.

An alternative might be to use a data store to configure this type of thing. I haven't thought through all the implications of that, but a config store might be a way of exposing pretty granular configuration to the site.

What's the handling like for experimental features? Could it be used to handling configuration of some more regular features?

ajlende · 2020-07-16T15:20:20Z

The experiments page settings live in the core/block-editor store, so it's not limited to just experimental settings. Seems like a reasonable store to use to me.

youknowriad · 2020-07-16T18:52:22Z

packages/block-editor/src/store/defaults.js

@@ -131,6 +132,9 @@ export const SETTINGS_DEFAULTS = {
 		{ slug: 'full', name: __( 'Full Size' ) },
 	],

+	// Allow plugin to disable Image Editor if need be
+	disableImageEditor: false,


What's if it's the opposite: imageEditing: true

It looks like the other block-editor settings use disable for example custom colors, font sizes, and gradients. I followed their lead on that.

These things may change once global styles is here. imageEditing allow for potentially having a more advanced config later (object).

@youknowriad I'm fine with switching. Is it ok to create it as imageEditing and keep it as a boolean, defaulting to true?

We would then be changing its type down the line if we add settings, but setting to false would work. If create it as an object, it will be empty to start, which is falsey, so tricky to test for disabled.

ajlende

Seems to work as intended 👍

sirreal

Thanks! I tested and this is working well. It makes sense to allow this more complicated feature to be disabled.

I'm not as familiar with the settings and don't have much opinion on the naming. I'm happy to let you and @youknowriad make a decision (#23966 (review)).

mkaz · 2020-07-17T15:07:52Z

Ok, I've updated to use the imageEditing settings, right now it is just a boolean and when set to false it is disabled. If we want to switch to an object to collect settings down the line we can, maintaining a false disables the feature.

I think this should be back ported to WP 5.5 so it goes out with the release in case any one needs to disable.

sirreal

I've retested and this works well 👍

youknowriad · 2020-07-20T08:27:48Z

Is there a dev note planned for the image editing feature? in which case, this should probably be mentioned there?

mkaz requested a review from sirreal July 15, 2020 17:59

mkaz requested a review from ajlende as a code owner July 15, 2020 17:59

mkaz force-pushed the try/option-disable-imgeditor branch from 2c1e240 to 844e5c8 Compare July 15, 2020 18:54

mkaz requested review from ellatrix and youknowriad as code owners July 16, 2020 18:20

youknowriad reviewed Jul 16, 2020

View reviewed changes

ajlende approved these changes Jul 16, 2020

View reviewed changes

mkaz added 2 commits July 16, 2020 15:43

Add option to disable Image Editor

54043d3

Switch disable to block-editor store

ccb12e1

mkaz force-pushed the try/option-disable-imgeditor branch from 854dba6 to ccb12e1 Compare July 16, 2020 22:43

sirreal approved these changes Jul 17, 2020

View reviewed changes

Switch to imageEditing settings

8e5e189

mkaz added [Block] Image Affects the Image Block Backport to WP Beta/RC Pull request that needs to be backported to the WordPress major release that's currently in beta labels Jul 17, 2020

sirreal approved these changes Jul 17, 2020

View reviewed changes

youknowriad merged commit 2cc76ba into master Jul 20, 2020

youknowriad deleted the try/option-disable-imgeditor branch July 20, 2020 08:28

github-actions bot added this to the Gutenberg 8.6 milestone Jul 20, 2020

mkaz mentioned this pull request Jul 20, 2020

Dev Notes for WP 5.5 #23669

Closed

12 tasks

ellatrix mentioned this pull request Jul 20, 2020

Backport GB 8.6 fixes to WP trunk #24068

Merged

6 tasks

ellatrix pushed a commit that referenced this pull request Jul 20, 2020

Image: Add the ability for a plugin to disable Image Editor (#23966)

60ae848

mcsf added the [Type] New API New API to be used by plugin developers or package users. label Jul 21, 2020

youknowriad removed the Backport to WP Beta/RC Pull request that needs to be backported to the WordPress major release that's currently in beta label Jul 22, 2020

miminari mentioned this pull request Dec 8, 2020

WordPress5.6対応 vektor-inc/vk-blocks-pro#137

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Image: Add the ability for a plugin to disable Image Editor #23966

Image: Add the ability for a plugin to disable Image Editor #23966

mkaz commented Jul 15, 2020 •

edited

github-actions bot commented Jul 15, 2020 •

edited

sirreal commented Jul 16, 2020

ajlende commented Jul 16, 2020

youknowriad Jul 16, 2020

mkaz Jul 16, 2020

youknowriad Jul 16, 2020

mkaz Jul 17, 2020

ajlende left a comment

sirreal left a comment

mkaz commented Jul 17, 2020

sirreal left a comment

youknowriad commented Jul 20, 2020 •

edited

Image: Add the ability for a plugin to disable Image Editor #23966

Image: Add the ability for a plugin to disable Image Editor #23966

Conversation

mkaz commented Jul 15, 2020 • edited

Description

How has this been tested?

Types of changes

Checklist:

github-actions bot commented Jul 15, 2020 • edited

sirreal commented Jul 16, 2020

ajlende commented Jul 16, 2020

youknowriad Jul 16, 2020

Choose a reason for hiding this comment

mkaz Jul 16, 2020

Choose a reason for hiding this comment

youknowriad Jul 16, 2020

Choose a reason for hiding this comment

mkaz Jul 17, 2020

Choose a reason for hiding this comment

ajlende left a comment

Choose a reason for hiding this comment

sirreal left a comment

Choose a reason for hiding this comment

mkaz commented Jul 17, 2020

sirreal left a comment

Choose a reason for hiding this comment

youknowriad commented Jul 20, 2020 • edited

mkaz commented Jul 15, 2020 •

edited

github-actions bot commented Jul 15, 2020 •

edited

youknowriad commented Jul 20, 2020 •

edited