WP_Theme_JSON_Data
云策文档标注
概述
WP_Theme_JSON_Data 类用于提供对 theme.json 结构进行更新的访问。它封装了 WP_Theme_JSON 对象，支持通过方法操作 theme.json 数据。
关键要点
- WP_Theme_JSON_Data 类用于管理和更新 theme.json 结构数据。
- 构造函数 __construct 接受 theme.json 规范数组和 origin 参数，初始化内部 WP_Theme_JSON 对象。
- update_with 方法使用新数据更新 theme.json，并返回实例自身以支持链式调用。
- get_data 方法返回遵循 theme.json 规范的原始数据数组。
- get_theme_json 方法返回内部存储的 WP_Theme_JSON 对象。
原文内容
Class to provide access to update a theme.json structure.
Methods
| Name | Description |
|---|---|
| WP_Theme_JSON_Data::__construct | Constructor. |
| WP_Theme_JSON_Data::get_data | Returns an array containing the underlying data following the theme.json specification. |
| WP_Theme_JSON_Data::get_theme_json | Returns theme JSON object. |
| WP_Theme_JSON_Data::update_with | Updates the theme.json with the the given data. |
Source
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;
}
}