From 4eee8105c8d61113a396f6fbeeb862689f91df7e Mon Sep 17 00:00:00 2001 From: Sergey Biryukov Date: Sat, 4 Dec 2021 15:55:03 +0000 Subject: [PATCH] Docs: Further update some `@since` notes in `WP_Theme_JSON` methods for clarity. Follow-up to [52049], [52306], [52320]. See #53399, #54336. git-svn-id: https://develop.svn.wordpress.org/trunk@52321 602fd350-edb4-49c9-b593-d223f7449a82 --- .../class-wp-theme-json-resolver.php | 12 +++++----- src/wp-includes/class-wp-theme-json.php | 24 ++++++++++--------- 2 files changed, 19 insertions(+), 17 deletions(-) diff --git a/src/wp-includes/class-wp-theme-json-resolver.php b/src/wp-includes/class-wp-theme-json-resolver.php index ce11c90aea..3fdd9da87e 100644 --- a/src/wp-includes/class-wp-theme-json-resolver.php +++ b/src/wp-includes/class-wp-theme-json-resolver.php @@ -63,8 +63,8 @@ class WP_Theme_JSON_Resolver { /** * Container to keep loaded i18n schema for `theme.json`. * - * @since 5.8.0 - * @since 5.9.0 Renamed from `$theme_json_i18n`. + * @since 5.8.0 As `$theme_json_i18n`. + * @since 5.9.0 Renamed from `$theme_json_i18n` to `$i18n_schema`. * @var array */ private static $i18n_schema = null; @@ -223,13 +223,13 @@ class WP_Theme_JSON_Resolver { * * @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. * @param bool $should_create_cpt Optional. Whether a new custom post * type should be created if none are - * found. False by default. - * @param array $post_status_filter Filter Optional. custom post type by - * post status. ['publish'] by default, + * found. Default false. + * @param array $post_status_filter Optional. Filter custom post type by + * post status. Default `array( 'publish' )`, * so it only fetches published posts. * @return array Custom Post Type for the user's origin config. */ diff --git a/src/wp-includes/class-wp-theme-json.php b/src/wp-includes/class-wp-theme-json.php index 949727775c..f13569f788 100644 --- a/src/wp-includes/class-wp-theme-json.php +++ b/src/wp-includes/class-wp-theme-json.php @@ -216,8 +216,8 @@ class WP_Theme_JSON { /** * The top-level keys a theme.json can have. * - * @since 5.8.0 - * @since 5.9.0 Renamed from `ALLOWED_TOP_LEVEL_KEYS`, + * @since 5.8.0 As `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. * @var string[] */ @@ -232,10 +232,10 @@ class WP_Theme_JSON { /** * The valid properties under the settings key. * - * @since 5.8.0 - * @since 5.9.0 Renamed from `ALLOWED_SETTINGS`, added new properties - * for `border`, `color`, `spacing`, and `typography`, - * and renamed others according to the new schema. + * @since 5.8.0 As `ALLOWED_SETTINGS`. + * @since 5.9.0 Renamed from `ALLOWED_SETTINGS` to `VALID_SETTINGS`, + * added new properties for `border`, `color`, `spacing`, + * and `typography`, and renamed others according to the new schema. * @var array */ const VALID_SETTINGS = array( @@ -287,9 +287,10 @@ class WP_Theme_JSON { /** * The valid properties under the styles key. * - * @since 5.8.0 - * @since 5.9.0 Renamed from `ALLOWED_SETTINGS`, added new properties - * for `border`, `filter`, `spacing`, and `typography`. + * @since 5.8.0 As `ALLOWED_STYLES`. + * @since 5.9.0 Renamed from `ALLOWED_STYLES` to `VALID_STYLES`, + * added new properties for `border`, `filter`, `spacing`, + * and `typography`. * @var array */ const VALID_STYLES = array( @@ -744,9 +745,10 @@ class WP_Theme_JSON { * 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()` * and no longer returns preset classes. + * Removed the `$setting_nodes` parameter. * * @param array $style_nodes Nodes with styles. * @return string The new stylesheet. @@ -1543,7 +1545,7 @@ class WP_Theme_JSON { * @since 5.9.0 * * @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. */ private static function get_slugs_not_to_override( $data, $node_path = array( 'settings' ) ) {