Skip to content

Adapt Gutenberg code to work after global styles lands in core #32059

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

Merged
youknowriad merged 16 commits into from
May 24, 2021
Merged

Adapt Gutenberg code to work after global styles lands in core #32059

Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
30e4ae1
Rename WP_Theme_JSON_Resolver to WP_Theme_JSON_Resolver_Gutenberg
oandregal May 20, 2021
178fe5f
Rename WP_Theme_JSON to WP_Theme_JSON_Gutenberg
oandregal May 20, 2021
d1fe1bf
Rename class-wp-theme-json.php to class-wp-theme-json-gutenberg.php
oandregal May 20, 2021
35770e3
Rename class-wp-theme-json-resolver.php to class-wp-theme-json-resolv…
oandregal May 20, 2021
661332e
Allow more settings in theme.json
oandregal May 21, 2021
fb82cbb
Change from theme_json_allowed_settings to theme_json_allowed_schema
oandregal May 21, 2021
431ac10
Improve filter to only update settings but not overwrite any other thing
oandregal May 21, 2021
0d685ae
Improve filter to respect other filters
oandregal May 21, 2021
0a60aa3
Provide core defaults for the new properties
oandregal May 21, 2021
008d509
Fix linting issues
oandregal May 21, 2021
40063ae
Provide base settings for WordPress < 5.8
oandregal May 21, 2021
7f4d94d
Make it work with WordPress 5.8-alpha
oandregal May 21, 2021
334b2f0
Fix linting issues
oandregal May 21, 2021
2ab0f40
Always re-create the settings
oandregal May 24, 2021
fd7496f
Lint issue: add full stop to comment
oandregal May 24, 2021
c8d8f22
remove wrong comments
ntsekouras May 24, 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
Prev Previous commit
Next Next commit
Always re-create the settings
  • Loading branch information
@oandregal
oandregal committed May 24, 2021
commit 2ab0f4089f8b0f50003127b6466c8b92e378022c
173 changes: 43 additions & 130 deletions lib/global-styles.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,54 +67,6 @@ function gutenberg_experimental_global_styles_enqueue_assets() {
wp_enqueue_style( 'global-styles' );
}

/**
* Adds the necessary settings for the Global Styles client UI.
*
* This can be removed when plugin support requires WordPress 5.8.0+.
*
* @param array $editor_settings Existing block editor settings.
*
* @return array New block editor settings.
*/
function gutenberg_experimental_global_styles_settings_5_8( $editor_settings ) {
$editor_settings['__experimentalFeatures'] = WP_Theme_JSON_Resolver_Gutenberg::get_merged_data( $editor_settings )->get_settings();

// These settings may need to be updated based on data coming from theme.json sources.
if ( isset( $editor_settings['__experimentalFeatures']['color']['palette'] ) ) {
$editor_settings['colors'] = $editor_settings['__experimentalFeatures']['color']['palette'];
}
if ( isset( $editor_settings['__experimentalFeatures']['color']['gradients'] ) ) {
$editor_settings['gradients'] = $editor_settings['__experimentalFeatures']['color']['gradients'];
}
if ( isset( $editor_settings['__experimentalFeatures']['color']['custom'] ) ) {
$editor_settings['disableCustomColors'] = $editor_settings['__experimentalFeatures']['color']['custom'];
}
if ( isset( $editor_settings['__experimentalFeatures']['color']['customGradient'] ) ) {
$editor_settings['disableCustomGradients'] = $editor_settings['__experimentalFeatures']['color']['customGradient'];
}
if ( isset( $editor_settings['__experimentalFeatures']['typography']['fontSizes'] ) ) {
$editor_settings['fontSizes'] = $editor_settings['__experimentalFeatures']['typography']['fontSizes'];
}
if ( isset( $editor_settings['__experimentalFeatures']['typography']['customFontSize'] ) ) {
$editor_settings['disableCustomFontSizes'] = $editor_settings['__experimentalFeatures']['typography']['customFontSize'];
}
if ( isset( $editor_settings['__experimentalFeatures']['typography']['customLineHeight'] ) ) {
$editor_settings['enableCustomLineHeight'] = $editor_settings['__experimentalFeatures']['typography']['customLineHeight'];
}
if ( isset( $editor_settings['__experimentalFeatures']['spacing']['units'] ) ) {
if ( ! is_array( $editor_settings['__experimentalFeatures']['spacing']['units'] ) ) {
$editor_settings['enableCustomUnits'] = false;
} else {
$editor_settings['enableCustomUnits'] = count( $editor_settings['__experimentalFeatures']['spacing']['units'] ) > 0;
}
}
if ( isset( $editor_settings['__experimentalFeatures']['spacing']['customPadding'] ) ) {
$editor_settings['enableCustomSpacing'] = $editor_settings['__experimentalFeatures']['spacing']['customPadding'];
}

return $editor_settings;
}

/**
* Adds the necessary settings for the Global Styles client UI.
*
Expand Down Expand Up @@ -182,6 +134,49 @@ function_exists( 'gutenberg_is_edit_site_page' ) &&
$settings['styles'][] = $block_styles;
}

// Copied from get_block_editor_settings() at wordpress-develop/block-editor.php
$settings['__experimentalFeatures'] = $consolidated->get_settings();
if ( isset( $settings['__experimentalFeatures']['color']['palette'] ) ) {
$settings['colors'] = $settings['__experimentalFeatures']['color']['palette'];
unset( $settings['__experimentalFeatures']['color']['palette'] );
}
if ( isset( $settings['__experimentalFeatures']['color']['gradients'] ) ) {
$settings['gradients'] = $settings['__experimentalFeatures']['color']['gradients'];
unset( $settings['__experimentalFeatures']['color']['gradients'] );
}
if ( isset( $settings['__experimentalFeatures']['color']['custom'] ) ) {
$settings['disableCustomColors'] = $settings['__experimentalFeatures']['color']['custom'];
unset( $settings['__experimentalFeatures']['color']['custom'] );
}
if ( isset( $settings['__experimentalFeatures']['color']['customGradient'] ) ) {
$settings['disableCustomGradients'] = $settings['__experimentalFeatures']['color']['customGradient'];
unset( $settings['__experimentalFeatures']['color']['customGradient'] );
}
if ( isset( $settings['__experimentalFeatures']['typography']['fontSizes'] ) ) {
$settings['fontSizes'] = $settings['__experimentalFeatures']['typography']['fontSizes'];
unset( $settings['__experimentalFeatures']['typography']['fontSizes'] );
}
if ( isset( $settings['__experimentalFeatures']['typography']['customFontSize'] ) ) {
$settings['disableCustomFontSizes'] = $settings['__experimentalFeatures']['typography']['customFontSize'];
unset( $settings['__experimentalFeatures']['typography']['customFontSize'] );
}
if ( isset( $settings['__experimentalFeatures']['typography']['customLineHeight'] ) ) {
$settings['enableCustomLineHeight'] = $settings['__experimentalFeatures']['typography']['customLineHeight'];
unset( $settings['__experimentalFeatures']['typography']['customLineHeight'] );
}
if ( isset( $settings['__experimentalFeatures']['spacing']['units'] ) ) {
if ( ! is_array( $settings['__experimentalFeatures']['spacing']['units'] ) ) {
$settings['enableCustomUnits'] = false;
} else {
$settings['enableCustomUnits'] = count( $settings['__experimentalFeatures']['spacing']['units'] ) > 0;
}
unset( $settings['__experimentalFeatures']['spacing']['units'] );
}
if ( isset( $settings['__experimentalFeatures']['spacing']['customPadding'] ) ) {
$settings['enableCustomSpacing'] = $settings['__experimentalFeatures']['spacing']['customPadding'];
unset( $settings['__experimentalFeatures']['spacing']['customPadding'] );
}

return $settings;
}

Expand Down Expand Up @@ -299,91 +294,9 @@ function gutenberg_global_styles_include_support_for_wp_variables( $allow_css, $
return ! ! preg_match( '/^var\(--wp-[a-zA-Z0-9\-]+\)$/', trim( $parts[1] ) );
}

/**
* Sets the default values for core data.
* Used to set the defaults to the new settings.
*
* @param array $data Existing core data.
*
* @return array New defaults for core data.
*/
function gutenberg_global_styles_theme_json_core_data( $data ) {
return array_merge(
$data,
array_merge_recursive(
array( 'settings' => $data['settings'] ),
array(
'settings' => array(
'border' => array(
'customColor' => false,
'customRadius' => false,
'customStyle' => false,
'customWidth' => false,
),
'typography' => array(
'customFontStyle' => true,
'customFontWeight' => true,
'customTextDecorations' => true,
'customTextTransforms' => true,
),
'blocks' => array(
'core/button' => array(
'border' => array(
'customRadius' => true,
),
),
),
),
)
)
);
}

/**
* Expands the theme.json schema provided by core.
*
* @param array $allowed_schema Existing schema.
*
* @return array New schema.
*/
function gutenberg_global_styles_theme_json_allowed_schema( $allowed_schema ) {
return array_merge(
$allowed_schema,
array_merge_recursive(
array( 'settings' => $allowed_schema['settings'] ),
array(
'settings' => array(
'border' => array(
'customColor' => null,
'customRadius' => null,
'customStyle' => null,
'customWidth' => null,
),
'typography' => array(
'customFontStyle' => null,
'customFontWeight' => null,
'customTextDecorations' => null,
'customTextTransforms' => null,
'fontFamilies' => null,
),
),
)
)
);
}

// The else clause can be removed when plugin support requires WordPress 5.8.0+.
if ( function_exists( 'get_block_editor_settings' ) ) {
add_filter( 'block_editor_settings_all', 'gutenberg_experimental_global_styles_settings', PHP_INT_MAX );
add_filter( 'theme_json_allowed_schema', 'gutenberg_global_styles_theme_json_allowed_schema' );
add_filter( 'theme_json_core_data', 'gutenberg_global_styles_theme_json_core_data' );

// This is only necessary to make it work with WordPress 5.8-alpha.
// When https://github.com/WordPress/wordpress-develop/pull/1262 lands
// and the wp-env is updated accordingly this can be removed.
if ( ! class_exists( 'WP_Theme_JSON' ) ) {
add_filter( 'block_editor_settings_all', 'gutenberg_experimental_global_styles_settings_5_8', PHP_INT_MAX );
}
} else {
add_filter( 'block_editor_settings', 'gutenberg_experimental_global_styles_settings', PHP_INT_MAX );
}
Expand Down