Changeset 52321

Timestamp:

12/04/2021 03:55:03 PM (3 years ago)

Author:

SergeyBiryukov

Message:

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

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

See #53399, #54336.

Location:

trunk/src/wp-includes

Files:

• class-wp-theme-json-resolver.php (modified) (2 diffs)
• class-wp-theme-json.php (modified) (5 diffs)

trunk/src/wp-includes/class-wp-theme-json-resolver.php

@@ -64 +64 @@
      * 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
      */
@@ -224 +224 @@
      * @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.

trunk/src/wp-includes/class-wp-theme-json.php

@@ -217 +217 @@
      * 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[]
@@ -233 +233 @@
      * 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
      */
@@ -288 +288 @@
      * 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
      */
@@ -745 +746 @@
      *   }
      *
-     * @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.
@@ -1544 +1546 @@
      *
      * @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.
      */