Skip to content

Update the WP_Theme_JSON_Gutenberg class to be like the core one #36973

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
oandregal merged 9 commits into from
Nov 29, 2021
Merged

Update the WP_Theme_JSON_Gutenberg class to be like the core one #36973

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
c5041be
Reorder constants and update constructor
oandregal Nov 29, 2021
122785d
Remove spaces from comment
oandregal Nov 29, 2021
c3df3b6
Update comments
oandregal Nov 29, 2021
2013188
Update comments
oandregal Nov 29, 2021
e368c8c
Reorder methods to follow WordPress core order so it is easier to bac…
oandregal Nov 29, 2021
47c15d3
Update comments
oandregal Nov 29, 2021
ae7a6c7
Port core changes to get_custom_templates and get_template_parts
oandregal Nov 29, 2021
37e60bc
Update comment
oandregal Nov 29, 2021
25bac06
Fix lint issues reported by the Gutenberg linter
oandregal Nov 29, 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
Next Next commit
Reorder constants and update constructor
  • Loading branch information
@oandregal
oandregal committed Nov 29, 2021
commit c5041be0302949aeab5783dc7fc209f59d018a16
230 changes: 135 additions & 95 deletions lib/class-wp-theme-json-gutenberg.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,20 @@
<?php
/**
* Process of structures that adhere to the theme.json schema.
* WP_Theme_JSON_Gutenberg class
*
* @package gutenberg
*/

/**
* Class that encapsulates the processing of
* structures that adhere to the theme.json spec.
* Class that encapsulates the processing of structures that adhere to the theme.json spec.
*
* This class is for internal core usage and is not supposed to be used by extenders (plugins and/or themes).
* This is a low-level API that may need to do breaking changes. Please,
* use get_global_settings, get_global_styles, and get_global_stylesheet instead.
*
* @access private
*/

class WP_Theme_JSON_Gutenberg {

/**
Expand All @@ -28,104 +34,24 @@ class WP_Theme_JSON_Gutenberg {
private static $blocks_metadata = null;

/**
* The CSS selector for the root block.
* The CSS selector for the top-level styles.
*
* @var string
*/
const ROOT_BLOCK_SELECTOR = 'body';

/**
* The sources of data this object can represent.
*
* @since 5.8.0
* @var string[]
*/
const VALID_ORIGINS = array(
'default',
'theme',
'custom',
);

const VALID_TOP_LEVEL_KEYS = array(
'customTemplates',
'templateParts',
'styles',
'settings',
'version',
);

const VALID_STYLES = array(
'border' => array(
'color' => null,
'radius' => null,
'style' => null,
'width' => null,
),
'color' => array(
'background' => null,
'gradient' => null,
'text' => null,
),
'filter' => array(
'duotone' => null,
),
'spacing' => array(
'margin' => null,
'padding' => null,
'blockGap' => null,
),
'typography' => array(
'fontFamily' => null,
'fontSize' => null,
'fontStyle' => null,
'fontWeight' => null,
'letterSpacing' => null,
'lineHeight' => null,
'textDecoration' => null,
'textTransform' => null,
),
);

const VALID_SETTINGS = array(
'appearanceTools' => null,
'border' => array(
'color' => null,
'radius' => null,
'style' => null,
'width' => null,
),
'color' => array(
'background' => null,
'custom' => null,
'customDuotone' => null,
'customGradient' => null,
'defaultGradients' => null,
'defaultPalette' => null,
'duotone' => null,
'gradients' => null,
'link' => null,
'palette' => null,
'text' => null,
),
'custom' => null,
'layout' => array(
'contentSize' => null,
'wideSize' => null,
),
'spacing' => array(
'blockGap' => null,
'margin' => null,
'padding' => null,
'units' => null,
),
'typography' => array(
'customFontSize' => null,
'dropCap' => null,
'fontFamilies' => null,
'fontSizes' => null,
'fontStyle' => null,
'fontWeight' => null,
'letterSpacing' => null,
'lineHeight' => null,
'textDecoration' => null,
'textTransform' => null,
),
);

/**
* Presets are a set of values that serve
* to bootstrap some styles: colors, font sizes, etc.
Expand Down Expand Up @@ -154,7 +80,7 @@ class WP_Theme_JSON_Gutenberg {
* - value_func => optionally, instead of value_key, a function to generate
* the value that takes a preset as an argument
*
* - css_var => name of the var to generate. The "$slug" substring will be
* - css_vars => name of the var to generate. The "$slug" substring will be
* replaced by the slug of each preset. For example,
* given a preset for color with two values whose slugs are "black" and "white",
* the string "--wp--preset--color--$slug" will generate two variables:
Expand All @@ -170,6 +96,7 @@ class WP_Theme_JSON_Gutenberg {
* '.has-$slug-background-color' => 'background-color',
* '.has-$slug-border-color' => 'border-color',
* )
*
* - properties => array of CSS properties to be used by kses to
* validate the content of each preset
* by means of the remove_insecure_properties method.
Expand Down Expand Up @@ -274,6 +201,112 @@ class WP_Theme_JSON_Gutenberg {
'spacing.blockGap' => array( 'spacing', 'blockGap' ),
);

/**
* The top-level keys a theme.json can have.
*
* @var string[]
*/
const VALID_TOP_LEVEL_KEYS = array(
'customTemplates',
'settings',
'styles',
'templateParts',
'version',
);

/**
* The valid properties under the settings key.
*
* @var array
*/
const VALID_SETTINGS = array(
'appearanceTools' => null,
'border' => array(
'color' => null,
'radius' => null,
'style' => null,
'width' => null,
),
'color' => array(
'background' => null,
'custom' => null,
'customDuotone' => null,
'customGradient' => null,
'defaultGradients' => null,
'defaultPalette' => null,
'duotone' => null,
'gradients' => null,
'link' => null,
'palette' => null,
'text' => null,
),
'custom' => null,
'layout' => array(
'contentSize' => null,
'wideSize' => null,
),
'spacing' => array(
'blockGap' => null,
'margin' => null,
'padding' => null,
'units' => null,
),
'typography' => array(
'customFontSize' => null,
'dropCap' => null,
'fontFamilies' => null,
'fontSizes' => null,
'fontStyle' => null,
'fontWeight' => null,
'letterSpacing' => null,
'lineHeight' => null,
'textDecoration' => null,
'textTransform' => null,
),
);

/**
* The valid properties under the styles key.
*
* @var array
*/
const VALID_STYLES = array(
'border' => array(
'color' => null,
'radius' => null,
'style' => null,
'width' => null,
),
'color' => array(
'background' => null,
'gradient' => null,
'text' => null,
),
'filter' => array(
'duotone' => null,
),
'spacing' => array(
'margin' => null,
'padding' => null,
'blockGap' => null,
),
'typography' => array(
'fontFamily' => null,
'fontSize' => null,
'fontStyle' => null,
'fontWeight' => null,
'letterSpacing' => null,
'lineHeight' => null,
'textDecoration' => null,
'textTransform' => null,
),
);

/**
* The valid elements that can be found under styles.
*
* @var string[]
*/
const ELEMENTS = array(
'link' => 'a',
'h1' => 'h1',
Expand All @@ -284,24 +317,31 @@ class WP_Theme_JSON_Gutenberg {
'h6' => 'h6',
);

/**
* The latest version of the schema in use.
*
* @var int
*/

const LATEST_SCHEMA = 2;

/**
* Constructor.
*
* @param array $theme_json A structure that follows the theme.json schema.
* @param string $origin What source of data this object represents. One of default, theme, or custom. Default: theme.
* @param array $theme_json A structure that follows the theme.json schema.
* @param string $origin Optional. What source of data this object represents.
* One of 'default', 'theme', or 'custom'. Default 'theme'.
*/
public function __construct( $theme_json = array(), $origin = 'theme' ) {
if ( ! in_array( $origin, self::VALID_ORIGINS, true ) ) {
$origin = 'theme';
}

$theme_json = WP_Theme_JSON_Schema_Gutenberg::migrate( $theme_json );
$this->theme_json = WP_Theme_JSON_Schema_Gutenberg::migrate( $theme_json );

$valid_block_names = array_keys( self::get_blocks_metadata() );
$valid_element_names = array_keys( self::ELEMENTS );
$theme_json = self::sanitize( $theme_json, $valid_block_names, $valid_element_names );
$theme_json = self::sanitize( $this->theme_json, $valid_block_names, $valid_element_names );
$this->theme_json = self::maybe_opt_in_into_settings( $theme_json );

// Internally, presets are keyed by origin.
Expand Down