2021-11-08 14:19:58 -05:00
|
|
|
<?php
|
|
|
|
/**
|
|
|
|
* WP_Theme_JSON_Schema class
|
|
|
|
*
|
|
|
|
* @package WordPress
|
|
|
|
* @subpackage Theme
|
|
|
|
* @since 5.9.0
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Class that migrates a given theme.json structure to the latest schema.
|
|
|
|
*
|
|
|
|
* 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.
|
|
|
|
*
|
2021-12-02 15:27:07 -05:00
|
|
|
* @since 5.9.0
|
2021-11-08 14:19:58 -05:00
|
|
|
* @access private
|
|
|
|
*/
|
Code Modernization: Add `AllowDynamicProperties` attribute to all (parent) classes.
Dynamic (non-explicitly declared) properties are deprecated as of PHP 8.2 and are expected to become a fatal error in PHP 9.0.
There are a number of ways to mitigate this:
* If it is an accidental typo for a declared property: fix the typo.
* For known properties: declare them on the class.
* For unknown properties: add the magic `__get()`, `__set()`, et al. methods to the class or let the class extend `stdClass` which has highly optimized versions of these magic methods built in.
* For unknown ''use'' of dynamic properties, the `#[AllowDynamicProperties]` attribute can be added to the class. The attribute will automatically be inherited by child classes.
Trac ticket #56034 is open to investigate and handle the third and fourth type of situations, however it has become clear this will need more time and will not be ready in time for WP 6.1.
To reduce “noise” in the meantime, both in the error logs of WP users moving onto PHP 8.2, in the test run logs of WP itself, in test runs of plugins and themes, as well as to prevent duplicate tickets from being opened for the same issue, this commit adds the `#[AllowDynamicProperties]` attribute to all “parent” classes in WP.
The logic used for this commit is as follows:
* If a class already has the attribute: no action needed.
* If a class does not `extend`: add the attribute.
* If a class does `extend`:
- If it extends `stdClass`: no action needed (as `stdClass` supports dynamic properties).
- If it extends a PHP native class: add the attribute.
- If it extends a class from one of WP's external dependencies: add the attribute.
* In all other cases: no action — the attribute should not be needed as child classes inherit from the parent.
Whether or not a class contains magic methods has not been taken into account, as a review of the currently existing magic methods has shown that those are generally not sturdy enough and often even set dynamic properties (which they should not). See the [https://www.youtube.com/watch?v=vDZWepDQQVE live stream from August 16, 2022] for more details.
This commit only affects classes in the `src` directory of WordPress core.
* Tests should not get this attribute, but should be fixed to not use dynamic properties instead. Patches for this are already being committed under ticket #56033.
* While a number bundled themes (2014, 2019, 2020, 2021) contain classes, they are not a part of this commit and may be updated separately.
Reference: [https://wiki.php.net/rfc/deprecate_dynamic_properties PHP RFC: Deprecate dynamic properties].
Follow-up to [53922].
Props jrf, hellofromTonya, markjaquith, peterwilsoncc, costdev, knutsp, aristath.
See #56513, #56034.
Built from https://develop.svn.wordpress.org/trunk@54133
git-svn-id: http://core.svn.wordpress.org/trunk@53692 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-09-12 11:47:14 -04:00
|
|
|
#[AllowDynamicProperties]
|
2021-11-08 14:19:58 -05:00
|
|
|
class WP_Theme_JSON_Schema {
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Maps old properties to their new location within the schema's settings.
|
|
|
|
* This will be applied at both the defaults and individual block levels.
|
|
|
|
*/
|
|
|
|
const V1_TO_V2_RENAMED_PATHS = array(
|
|
|
|
'border.customRadius' => 'border.radius',
|
|
|
|
'spacing.customMargin' => 'spacing.margin',
|
|
|
|
'spacing.customPadding' => 'spacing.padding',
|
|
|
|
'typography.customLineHeight' => 'typography.lineHeight',
|
|
|
|
);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Function that migrates a given theme.json structure to the last version.
|
|
|
|
*
|
2021-12-02 15:27:07 -05:00
|
|
|
* @since 5.9.0
|
2024-06-04 07:55:14 -04:00
|
|
|
* @since 6.6.0 Migrate up to v3.
|
2021-12-02 15:27:07 -05:00
|
|
|
*
|
2021-11-08 14:19:58 -05:00
|
|
|
* @param array $theme_json The structure to migrate.
|
|
|
|
*
|
|
|
|
* @return array The structure in the last version.
|
|
|
|
*/
|
|
|
|
public static function migrate( $theme_json ) {
|
|
|
|
if ( ! isset( $theme_json['version'] ) ) {
|
|
|
|
$theme_json = array(
|
|
|
|
'version' => WP_Theme_JSON::LATEST_SCHEMA,
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
2024-06-04 07:55:14 -04:00
|
|
|
// Migrate each version in order starting with the current version.
|
|
|
|
switch ( $theme_json['version'] ) {
|
|
|
|
case 1:
|
|
|
|
$theme_json = self::migrate_v1_to_v2( $theme_json );
|
|
|
|
// no break
|
|
|
|
case 2:
|
|
|
|
$theme_json = self::migrate_v2_to_v3( $theme_json );
|
|
|
|
// no break
|
2021-11-08 14:19:58 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
return $theme_json;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Removes the custom prefixes for a few properties
|
|
|
|
* that were part of v1:
|
|
|
|
*
|
|
|
|
* 'border.customRadius' => 'border.radius',
|
|
|
|
* 'spacing.customMargin' => 'spacing.margin',
|
|
|
|
* 'spacing.customPadding' => 'spacing.padding',
|
|
|
|
* 'typography.customLineHeight' => 'typography.lineHeight',
|
|
|
|
*
|
2021-12-02 15:27:07 -05:00
|
|
|
* @since 5.9.0
|
|
|
|
*
|
2021-11-08 14:19:58 -05:00
|
|
|
* @param array $old Data to migrate.
|
|
|
|
*
|
|
|
|
* @return array Data without the custom prefixes.
|
|
|
|
*/
|
|
|
|
private static function migrate_v1_to_v2( $old ) {
|
|
|
|
// Copy everything.
|
|
|
|
$new = $old;
|
|
|
|
|
|
|
|
// Overwrite the things that changed.
|
|
|
|
if ( isset( $old['settings'] ) ) {
|
|
|
|
$new['settings'] = self::rename_paths( $old['settings'], self::V1_TO_V2_RENAMED_PATHS );
|
|
|
|
}
|
|
|
|
|
|
|
|
// Set the new version.
|
|
|
|
$new['version'] = 2;
|
|
|
|
|
|
|
|
return $new;
|
|
|
|
}
|
|
|
|
|
2024-06-04 07:55:14 -04:00
|
|
|
/**
|
|
|
|
* Migrates from v2 to v3.
|
|
|
|
*
|
|
|
|
* - Sets settings.typography.defaultFontSizes to false.
|
|
|
|
*
|
|
|
|
* @since 6.6.0
|
|
|
|
*
|
|
|
|
* @param array $old Data to migrate.
|
|
|
|
*
|
|
|
|
* @return array Data with defaultFontSizes set to false.
|
|
|
|
*/
|
|
|
|
private static function migrate_v2_to_v3( $old ) {
|
|
|
|
// Copy everything.
|
|
|
|
$new = $old;
|
|
|
|
|
|
|
|
// Set the new version.
|
|
|
|
$new['version'] = 3;
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Remaining changes do not need to be applied to the custom origin,
|
|
|
|
* as they should take on the value of the theme origin.
|
|
|
|
*/
|
|
|
|
if (
|
|
|
|
isset( $new['isGlobalStylesUserThemeJSON'] ) &&
|
|
|
|
true === $new['isGlobalStylesUserThemeJSON']
|
|
|
|
) {
|
|
|
|
return $new;
|
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Even though defaultFontSizes and defaultSpacingSizes are new
|
|
|
|
* settings, we need to migrate them as they each control
|
|
|
|
* PRESETS_METADATA prevent_override values which were previously
|
|
|
|
* hardcoded to false. This only needs to happen when the theme provides
|
|
|
|
* fontSizes or spacingSizes as they could match the default ones and
|
|
|
|
* affect the generated CSS.
|
|
|
|
*/
|
|
|
|
if ( isset( $old['settings']['typography']['fontSizes'] ) ) {
|
|
|
|
if ( ! isset( $new['settings'] ) ) {
|
|
|
|
$new['settings'] = array();
|
|
|
|
}
|
|
|
|
if ( ! isset( $new['settings']['typography'] ) ) {
|
|
|
|
$new['settings']['typography'] = array();
|
|
|
|
}
|
|
|
|
$new['settings']['typography']['defaultFontSizes'] = false;
|
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Similarly to defaultFontSizes, we need to migrate defaultSpacingSizes
|
|
|
|
* as it controls the PRESETS_METADATA prevent_override which was
|
|
|
|
* previously hardcoded to false. This only needs to happen when the
|
|
|
|
* theme provided spacing sizes via spacingSizes or spacingScale.
|
|
|
|
*/
|
|
|
|
if (
|
|
|
|
isset( $old['settings']['spacing']['spacingSizes'] ) ||
|
|
|
|
isset( $old['settings']['spacing']['spacingScale'] )
|
|
|
|
) {
|
|
|
|
if ( ! isset( $new['settings'] ) ) {
|
|
|
|
$new['settings'] = array();
|
|
|
|
}
|
|
|
|
if ( ! isset( $new['settings']['spacing'] ) ) {
|
|
|
|
$new['settings']['spacing'] = array();
|
|
|
|
}
|
|
|
|
$new['settings']['spacing']['defaultSpacingSizes'] = false;
|
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
* In v3 spacingSizes is merged with the generated spacingScale sizes
|
|
|
|
* instead of completely replacing them. The v3 behavior is what was
|
|
|
|
* documented for the v2 schema, but the code never actually did work
|
|
|
|
* that way. Instead of surprising users with a behavior change two
|
|
|
|
* years after the fact at the same time as a v3 update is introduced,
|
|
|
|
* we'll continue using the "bugged" behavior for v2 themes. And treat
|
|
|
|
* the "bug fix" as a breaking change for v3.
|
|
|
|
*/
|
|
|
|
if ( isset( $old['settings']['spacing']['spacingSizes'] ) ) {
|
|
|
|
unset( $new['settings']['spacing']['spacingScale'] );
|
|
|
|
}
|
|
|
|
|
|
|
|
return $new;
|
|
|
|
}
|
|
|
|
|
2021-11-08 14:19:58 -05:00
|
|
|
/**
|
|
|
|
* Processes the settings subtree.
|
|
|
|
*
|
2021-12-02 15:27:07 -05:00
|
|
|
* @since 5.9.0
|
|
|
|
*
|
2021-11-08 14:19:58 -05:00
|
|
|
* @param array $settings Array to process.
|
|
|
|
* @param array $paths_to_rename Paths to rename.
|
|
|
|
*
|
|
|
|
* @return array The settings in the new format.
|
|
|
|
*/
|
|
|
|
private static function rename_paths( $settings, $paths_to_rename ) {
|
|
|
|
$new_settings = $settings;
|
|
|
|
|
|
|
|
// Process any renamed/moved paths within default settings.
|
|
|
|
self::rename_settings( $new_settings, $paths_to_rename );
|
|
|
|
|
|
|
|
// Process individual block settings.
|
|
|
|
if ( isset( $new_settings['blocks'] ) && is_array( $new_settings['blocks'] ) ) {
|
|
|
|
foreach ( $new_settings['blocks'] as &$block_settings ) {
|
|
|
|
self::rename_settings( $block_settings, $paths_to_rename );
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return $new_settings;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Processes a settings array, renaming or moving properties.
|
|
|
|
*
|
2021-12-02 15:27:07 -05:00
|
|
|
* @since 5.9.0
|
|
|
|
*
|
2021-11-08 14:19:58 -05:00
|
|
|
* @param array $settings Reference to settings either defaults or an individual block's.
|
2021-12-02 15:45:01 -05:00
|
|
|
* @param array $paths_to_rename Paths to rename.
|
2021-11-08 14:19:58 -05:00
|
|
|
*/
|
|
|
|
private static function rename_settings( &$settings, $paths_to_rename ) {
|
|
|
|
foreach ( $paths_to_rename as $original => $renamed ) {
|
|
|
|
$original_path = explode( '.', $original );
|
|
|
|
$renamed_path = explode( '.', $renamed );
|
|
|
|
$current_value = _wp_array_get( $settings, $original_path, null );
|
|
|
|
|
|
|
|
if ( null !== $current_value ) {
|
|
|
|
_wp_array_set( $settings, $renamed_path, $current_value );
|
|
|
|
self::unset_setting_by_path( $settings, $original_path );
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Removes a property from within the provided settings by its path.
|
|
|
|
*
|
2021-12-02 15:27:07 -05:00
|
|
|
* @since 5.9.0
|
|
|
|
*
|
2021-11-08 14:19:58 -05:00
|
|
|
* @param array $settings Reference to the current settings array.
|
|
|
|
* @param array $path Path to the property to be removed.
|
|
|
|
*/
|
|
|
|
private static function unset_setting_by_path( &$settings, $path ) {
|
Coding Standards: Remove redundant ignore annotations, take 5.
The `VariableAnalysis` standard is not used by WP Core.
Follow-up to [50958], [51003], [52049], [52051], [52069], [53072], [54132], [55132], [56363], [56738], [56743], [56751], [56752].
Props jrf.
See #59161.
Built from https://develop.svn.wordpress.org/trunk@56753
git-svn-id: http://core.svn.wordpress.org/trunk@56265 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-10-02 07:27:24 -04:00
|
|
|
$tmp_settings = &$settings;
|
2021-11-08 14:19:58 -05:00
|
|
|
$last_key = array_pop( $path );
|
|
|
|
foreach ( $path as $key ) {
|
|
|
|
$tmp_settings = &$tmp_settings[ $key ];
|
|
|
|
}
|
|
|
|
|
|
|
|
unset( $tmp_settings[ $last_key ] );
|
|
|
|
}
|
|
|
|
}
|