WordPress/wp-includes/class-wp-theme-json-data.php

84 lines
1.8 KiB
PHP
Raw Normal View History

<?php
/**
* WP_Theme_JSON_Data class
*
* @package WordPress
* @subpackage Theme
* @since 6.1.0
*/
/**
* Class to provide access to update a theme.json structure.
*/
Code Modernization: Add `AllowDynamicProperties` attribute to recently introduced classes. This commit is a follow-up to [54133] for new classes introduced in WordPress 6.1 since the previous commit. 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, the `#[AllowDynamicProperties]` attribute has been added to all “parent” classes in WP. Reference: [https://wiki.php.net/rfc/deprecate_dynamic_properties PHP RFC: Deprecate dynamic properties]. Follow-up to [53922], [54133]. Props jrf. See #56513, #56034. Built from https://develop.svn.wordpress.org/trunk@54481 git-svn-id: http://core.svn.wordpress.org/trunk@54040 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-10-11 17:00:12 +02:00
#[AllowDynamicProperties]
class WP_Theme_JSON_Data {
/**
* Container of the data to update.
*
* @since 6.1.0
* @var WP_Theme_JSON
*/
private $theme_json = null;
/**
* The origin of the data: default, theme, user, etc.
*
* @since 6.1.0
* @var string
*/
private $origin = '';
/**
* Constructor.
*
* @since 6.1.0
*
* @link https://developer.wordpress.org/block-editor/reference-guides/theme-json-reference/
*
* @param array $data Array following the theme.json specification.
* @param string $origin The origin of the data: default, theme, user.
*/
public function __construct( $data = array( 'version' => WP_Theme_JSON::LATEST_SCHEMA ), $origin = 'theme' ) {
$this->origin = $origin;
$this->theme_json = new WP_Theme_JSON( $data, $this->origin );
}
/**
* Updates the theme.json with the the given data.
*
* @since 6.1.0
*
* @param array $new_data Array following the theme.json specification.
*
* @return WP_Theme_JSON_Data The own instance with access to the modified data.
*/
public function update_with( $new_data ) {
$this->theme_json->merge( new WP_Theme_JSON( $new_data, $this->origin ) );
return $this;
}
/**
* Returns an array containing the underlying data
* following the theme.json specification.
*
* @since 6.1.0
*
* @return array
*/
public function get_data() {
return $this->theme_json->get_raw_data();
}
/**
* Returns theme JSON object.
*
* @since 6.6.0
*
* @return WP_Theme_JSON The theme JSON structure stored in this data object.
*/
public function get_theme_json() {
return $this->theme_json;
}
}