Docs: Further update some `@since` notes in `WP_Theme_JSON` methods for clarity.

Follow-up to [52049], [52306], [52320].

See #53399, #54336.
Built from https://develop.svn.wordpress.org/trunk@52321


git-svn-id: http://core.svn.wordpress.org/trunk@51913 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov 2021-12-04 15:57:01 +00:00
parent 7f9d7a5905
commit 6b84ae03ad
3 changed files with 20 additions and 18 deletions

View File

@ -63,8 +63,8 @@ class WP_Theme_JSON_Resolver {
/** /**
* Container to keep loaded i18n schema for `theme.json`. * Container to keep loaded i18n schema for `theme.json`.
* *
* @since 5.8.0 * @since 5.8.0 As `$theme_json_i18n`.
* @since 5.9.0 Renamed from `$theme_json_i18n`. * @since 5.9.0 Renamed from `$theme_json_i18n` to `$i18n_schema`.
* @var array * @var array
*/ */
private static $i18n_schema = null; private static $i18n_schema = null;
@ -223,13 +223,13 @@ class WP_Theme_JSON_Resolver {
* *
* @since 5.9.0 * @since 5.9.0
* *
* @param WP_Theme $theme The theme object. If empty, it * @param WP_Theme $theme The theme object. If empty, it
* defaults to the current theme. * defaults to the current theme.
* @param bool $should_create_cpt Optional. Whether a new custom post * @param bool $should_create_cpt Optional. Whether a new custom post
* type should be created if none are * type should be created if none are
* found. False by default. * found. Default false.
* @param array $post_status_filter Filter Optional. custom post type by * @param array $post_status_filter Optional. Filter custom post type by
* post status. ['publish'] by default, * post status. Default `array( 'publish' )`,
* so it only fetches published posts. * so it only fetches published posts.
* @return array Custom Post Type for the user's origin config. * @return array Custom Post Type for the user's origin config.
*/ */

View File

@ -216,8 +216,8 @@ class WP_Theme_JSON {
/** /**
* The top-level keys a theme.json can have. * The top-level keys a theme.json can have.
* *
* @since 5.8.0 * @since 5.8.0 As `ALLOWED_TOP_LEVEL_KEYS`.
* @since 5.9.0 Renamed from `ALLOWED_TOP_LEVEL_KEYS`, * @since 5.9.0 Renamed from `ALLOWED_TOP_LEVEL_KEYS` to `VALID_TOP_LEVEL_KEYS`,
* added the `customTemplates` and `templateParts` values. * added the `customTemplates` and `templateParts` values.
* @var string[] * @var string[]
*/ */
@ -232,10 +232,10 @@ class WP_Theme_JSON {
/** /**
* The valid properties under the settings key. * The valid properties under the settings key.
* *
* @since 5.8.0 * @since 5.8.0 As `ALLOWED_SETTINGS`.
* @since 5.9.0 Renamed from `ALLOWED_SETTINGS`, added new properties * @since 5.9.0 Renamed from `ALLOWED_SETTINGS` to `VALID_SETTINGS`,
* for `border`, `color`, `spacing`, and `typography`, * added new properties for `border`, `color`, `spacing`,
* and renamed others according to the new schema. * and `typography`, and renamed others according to the new schema.
* @var array * @var array
*/ */
const VALID_SETTINGS = array( const VALID_SETTINGS = array(
@ -287,9 +287,10 @@ class WP_Theme_JSON {
/** /**
* The valid properties under the styles key. * The valid properties under the styles key.
* *
* @since 5.8.0 * @since 5.8.0 As `ALLOWED_STYLES`.
* @since 5.9.0 Renamed from `ALLOWED_SETTINGS`, added new properties * @since 5.9.0 Renamed from `ALLOWED_STYLES` to `VALID_STYLES`,
* for `border`, `filter`, `spacing`, and `typography`. * added new properties for `border`, `filter`, `spacing`,
* and `typography`.
* @var array * @var array
*/ */
const VALID_STYLES = array( const VALID_STYLES = array(
@ -744,9 +745,10 @@ class WP_Theme_JSON {
* style-property-one: value; * style-property-one: value;
* } * }
* *
* @since 5.8.0 * @since 5.8.0 As `get_block_styles()`.
* @since 5.9.0 Renamed from `get_block_styles()` to `get_block_classes()` * @since 5.9.0 Renamed from `get_block_styles()` to `get_block_classes()`
* and no longer returns preset classes. * and no longer returns preset classes.
* Removed the `$setting_nodes` parameter.
* *
* @param array $style_nodes Nodes with styles. * @param array $style_nodes Nodes with styles.
* @return string The new stylesheet. * @return string The new stylesheet.
@ -1543,7 +1545,7 @@ class WP_Theme_JSON {
* @since 5.9.0 * @since 5.9.0
* *
* @param array $data A theme.json like structure to inspect. * @param array $data A theme.json like structure to inspect.
* @param array $node_path The path to inspect. Default is 'settings'. * @param array $node_path The path to inspect. Default `array( 'settings' )`.
* @return array An associative array containing the slugs for the given path. * @return array An associative array containing the slugs for the given path.
*/ */
private static function get_slugs_not_to_override( $data, $node_path = array( 'settings' ) ) { private static function get_slugs_not_to_override( $data, $node_path = array( 'settings' ) ) {

View File

@ -16,7 +16,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '5.9-beta1-52320'; $wp_version = '5.9-beta1-52321';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.