Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enqueue global styles in editor only once #32377

Merged
merged 3 commits into from
Jun 8, 2021
Merged

Enqueue global styles in editor only once #32377

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
974ce11
Enqueue global styles in editor only once
oandregal Jun 1, 2021
e120224
Fix lint issues
oandregal Jun 1, 2021
feacc44
Update key to core changes
oandregal Jun 2, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions lib/global-styles.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,14 @@ function_exists( 'gutenberg_is_edit_site_page' ) &&
'__experimentalNoWrapper' => true,
);

// Reset existing global styles.
foreach ( $settings['styles'] as $key => $style ) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nosolosw Should $settings['styles'] always be defined before this line? This throws an error in the navigation editor which doesn't have a style setting beforehand, but still calls the gutenberg_experimental_global_styles_settings function.

Not entirely sure what the right way to solve that is, so any advice would be appreciated.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Dan, I've prepared #33127

But now I'm wondering if I understood the issue correctly: did you mean that the global styles shouldn't be present in the navigation editor either?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If that's the case, we may want to change the logic of this function to:

if ( 'mobile' === context ) { /* extra data for mobile */ } 
if ( 'site-editor' === context ) { /* extra data for site editor */ } 
if ( 'post-editor' === context ) { /* extra data for post editor */ } 

// editor settings for all: mobile, site-editor, post-editor, navigation-editor, etc.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that fix is correct as a defensive measure. One can't guarantee that the key will always be there so let's check for that.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But now I'm wondering if I understood the issue correctly: did you mean that the global styles shouldn't be present in the navigation editor either?

I'm not really sure on an answer for that right now. The navigation editor needs to evolve a bit. Probably in the basic mode the navigation editor doesn't need it, but there's an option for themes to opt in to some more advanced block features, and it might be an option for global styles to work in that case.

This fix works as an interim, so thank you! 👍

if ( isset( $style['__unstableType'] ) && 'globalStyles' === $style['__unstableType'] ) {
unset( $settings['styles'][ $key ] );
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The problem with "unset" is that the "styles" will become an object instead of an array when passing to JS, which could have some unintended side effects. I'm fixing that here eea9799

}
}

// Add the new ones.
$settings['styles'][] = $css_variables;
$settings['styles'][] = $block_styles;
}
Expand Down