Advanced Panels: Add support for the 'Custom Fields' meta box #11084

noisysocks · 2018-10-26T03:10:43Z

Closes #3228.

Adds an option which allows the user to enable the existing 'postcustom' meta box included in WordPress.

I've implemented this using the super hacky approach described in #10676 (comment) 😎

The benefits of this approach are that:

We can reuse the existing 'postcustom' meta box.
The 'postcustom' assets aren't loaded unless the option is enabled.

The downsides are that:

We have to store the option on the server (e.g. using a site option).
The editor has to be reloaded when the option changes, which is pretty jarring.

youknowriad

This makes sense unless we have REST API support for custom fields which I don't really expect it to come in 5.0 (or later?)

I'm adding some reviewers more familiar with the PHP side of things.

danielbachhuber

Looking good! Few things to address.

lib/meta-box-partial-page.php

packages/edit-post/src/components/options-modal/options/enable-custom-fields.js

danielbachhuber · 2018-10-26T11:10:48Z

lib/client-assets.php

@@ -1573,14 +1573,27 @@ function gutenberg_editor_scripts_and_styles( $hook ) {
 		'maxUploadFileSize'      => $max_upload_size,


It works!

Should I be seeing that error message though?

I saw the error mentioned for other meta boxes elsewhere. I wonder if it's a more generic bug in 5.0?

How did you get this error?

It's a bug in 5.0, fixed now.

lib/meta-box-partial-page.php

noisysocks · 2018-10-29T00:42:59Z

Noting to myself that since this touches the PHP we'll need to bring over these changes to the 5.0 branch.

Feedback has been addressed 🙂

noisysocks · 2018-10-31T00:59:25Z

How do we feel about this? Would like to get it into the 5.0 RC.

talldan

I had a look at the front-end side of things. The changes seem to be pretty minor there. Looks good to me - seems mergeable if the backend changes also look acceptable.

packages/edit-post/src/components/options-modal/index.js

packages/edit-post/src/components/options-modal/options/enable-custom-fields.js

websupporter · 2018-11-01T05:41:23Z

How does this approach take into account a custom post type where custom-fields are not supported, like for example

add_action('init', function() {
        remove_post_type_support( 'post', 'custom-fields' );
});

I would expect the option to not show up in the first place, but from a quick view into the code, I can't see a toggle for that.

In the classic editor, when I go to the screen options, the "Custom Fields"-option disappears when the support has been removed.

packages/edit-post/src/components/options-modal/index.js

- Adds an option which allows the user to enable the existing 'postcustom' meta box included in WordPress. - Don't load the 'postcustom' assets when the option is disabled. - Stores the option as a site option. - Reload the editor when the option is changed.

The 'Enable Tips' checkbox is obscured by the first Tip now that the Options modal is taller. Work around this by only testing that tips can be re-enabled.

We can simply interpolate $post->ID when initializing Custom Fields, rather than selecting from the #post_ID hidden field.

By using `get_user_meta()` instead of `get_option()`, the Custom Fields setting won't affect other users.

Trigger the toggle_custom_fields action using a hidden <form> so that the action is triggered by a POST request rather than a GET request.

noisysocks · 2018-11-02T01:57:32Z

Thanks all. I've responded to feedback and fixed the problem where Custom Fields would display in post types that don't support postcustom.

One issue I've noticed: when the Advanced Custom Fields plugin is enabled, the Custom Fields toggle is displayed even though it doesn't do anything. This is because the ACF plugin removes postcustom from the list of registered meta boxes. I don't think it's a blocker for this PR. Likely the fix is that ACF, when enabled, will have to mark the post type as not supporting custom-fields.

talldan

Yep, it's undergone a lot of reviews and feedback looks all addressed 👍

noisysocks · 2018-11-02T03:12:09Z

🙈

noisysocks · 2018-11-02T03:26:51Z

One issue I've noticed: when the Advanced Custom Fields plugin is enabled, the Custom Fields toggle is displayed even though it doesn't do anything. This is because the ACF plugin removes postcustom from the list of registered meta boxes. I don't think it's a blocker for this PR. Likely the fix is that ACF, when enabled, will have to mark the post type as not supporting custom-fields.

Created a follow-up issue for this here: #11386

noisysocks · 2018-11-02T03:37:54Z

Lastly, created a ticket to remind ourselves to copy over the necessary PHP changes to Core: https://core.trac.wordpress.org/ticket/45257

noisysocks added [Feature] Meta Boxes A draggable box shown on the post editing screen Backwards Compatibility Issues or PRs that impact backwards compatability labels Oct 26, 2018

noisysocks requested a review from youknowriad October 26, 2018 03:10

noisysocks force-pushed the try/custom-fields-meta-box branch from 39f67ed to 691e42b Compare October 26, 2018 03:25

youknowriad reviewed Oct 26, 2018

View reviewed changes

youknowriad requested review from aduth, danielbachhuber and pento October 26, 2018 09:21

danielbachhuber previously requested changes Oct 26, 2018

View reviewed changes

noisysocks requested a review from talldan October 31, 2018 00:58

talldan reviewed Oct 31, 2018

View reviewed changes

packages/edit-post/src/components/options-modal/index.js Outdated Show resolved Hide resolved

packages/edit-post/src/components/options-modal/options/enable-custom-fields.js Outdated Show resolved Hide resolved

websupporter reviewed Nov 1, 2018

View reviewed changes

packages/edit-post/src/components/options-modal/index.js Outdated Show resolved Hide resolved

noisysocks added 8 commits November 2, 2018 11:13

Fix E2E tests

8e4bae5

The 'Enable Tips' checkbox is obscured by the first Tip now that the Options modal is taller. Work around this by only testing that tips can be re-enabled.

Custom Fields: Remove unnecessary jQuery selector

d91cd88

We can simply interpolate $post->ID when initializing Custom Fields, rather than selecting from the #post_ID hidden field.

Custom Fields: Use user meta field instead of site option

391fbfc

By using `get_user_meta()` instead of `get_option()`, the Custom Fields setting won't affect other users.

Custom Fields: Kill the process after redirecting

cba7747

Custom Fields: Use hidden <form> instead of redirect

2491a18

Trigger the toggle_custom_fields action using a hidden <form> so that the action is triggered by a POST request rather than a GET request.

Custom Fields: Rename isEnabled → isChecked

2c11c00

Custom Fields: Move meta box options into their own component

a7d0a0c

noisysocks force-pushed the try/custom-fields-meta-box branch 2 times, most recently from 292485a to c01629c Compare November 2, 2018 01:28

Custom Fields: Only show option if custom fields are supported

6368b56

noisysocks force-pushed the try/custom-fields-meta-box branch from c01629c to 6368b56 Compare November 2, 2018 01:31

noisysocks added this to the 4.3 milestone Nov 2, 2018

talldan approved these changes Nov 2, 2018

View reviewed changes

noisysocks merged commit e30f36f into master Nov 2, 2018

noisysocks deleted the try/custom-fields-meta-box branch November 2, 2018 03:12

noisysocks mentioned this pull request Nov 2, 2018

Custom Fields option displays when ACF is enabled #11386

Closed

andergmartins mentioned this pull request Nov 13, 2018

Add support for Gutenberg publishpress/PublishPress-Planner#296

Closed

2 tasks

noisysocks mentioned this pull request Dec 5, 2018

ACF Metaboxes are always visible #12571

Closed

noisysocks mentioned this pull request May 8, 2019

Custom field check box automatically changes the context on user focus #15320

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Advanced Panels: Add support for the 'Custom Fields' meta box #11084

Advanced Panels: Add support for the 'Custom Fields' meta box #11084

noisysocks commented Oct 26, 2018 •

edited

youknowriad left a comment

danielbachhuber left a comment

danielbachhuber Oct 26, 2018

youknowriad Oct 26, 2018

noisysocks Oct 29, 2018

pento Oct 29, 2018

noisysocks commented Oct 29, 2018

noisysocks commented Oct 31, 2018

talldan left a comment

websupporter commented Nov 1, 2018

noisysocks commented Nov 2, 2018

talldan left a comment

noisysocks commented Nov 2, 2018

noisysocks commented Nov 2, 2018

noisysocks commented Nov 2, 2018

		@@ -1573,14 +1573,27 @@ function gutenberg_editor_scripts_and_styles( $hook ) {
		'maxUploadFileSize' => $max_upload_size,

Advanced Panels: Add support for the 'Custom Fields' meta box #11084

Advanced Panels: Add support for the 'Custom Fields' meta box #11084

Conversation

noisysocks commented Oct 26, 2018 • edited

youknowriad left a comment

Choose a reason for hiding this comment

danielbachhuber left a comment

Choose a reason for hiding this comment

danielbachhuber Oct 26, 2018

Choose a reason for hiding this comment

youknowriad Oct 26, 2018

Choose a reason for hiding this comment

noisysocks Oct 29, 2018

Choose a reason for hiding this comment

pento Oct 29, 2018

Choose a reason for hiding this comment

noisysocks commented Oct 29, 2018

noisysocks commented Oct 31, 2018

talldan left a comment

Choose a reason for hiding this comment

websupporter commented Nov 1, 2018

noisysocks commented Nov 2, 2018

talldan left a comment

Choose a reason for hiding this comment

noisysocks commented Nov 2, 2018

noisysocks commented Nov 2, 2018

noisysocks commented Nov 2, 2018

noisysocks commented Oct 26, 2018 •

edited