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

Timestamp:

12/04/2021 12:56:29 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Some documentation improvements for WP_Theme_JSON and WP_Theme_JSON_Resolver classes:

• Make the @since 5.9.0 notes more specific. When mentioning that parameters or values have been added or changed, it is generally also helpful to include their exact names and the nature of changes for future reference.
• Update some DocBlocks per the documentation standards.

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

See #53399, #54336.

File:

• trunk/src/wp-includes/class-wp-theme-json-resolver.php (modified) (7 diffs)

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

@@ -57 +57 @@
          *
          * @since 5.9.0
-         * @var integer
+         * @var int
          */
         private static $user_custom_post_type_id = null;
@@ -65 +65 @@
          *
          * @since 5.8.0
-         * @since 5.9.0 Renamed from $theme_json_i18n
+         * @since 5.9.0 Renamed from `$theme_json_i18n`.
          * @var array
          */
@@ -151 +151 @@
          *
          * @since 5.8.0
-         * @since 5.9.0 Theme supports have been inlined and the argument removed.
-         *
+         * @since 5.9.0 Theme supports have been inlined and the `$theme_support_data` argument removed.
+         *
+         * @param array $deprecated Deprecated. Not used.
          * @return WP_Theme_JSON Entity that holds theme data.
          */
         public static function get_theme_data( $deprecated = array() ) {
                 if ( ! empty( $deprecated ) ) {
-                        _deprecated_argument( __METHOD__, '5.9' );
+                        _deprecated_argument( __METHOD__, '5.9.0' );
                 }
                 if ( null === self::$theme ) {
@@ -348 +349 @@
          *
          * @since 5.8.0
-         * @since 5.9.0 Add user data and change the arguments.
+         * @since 5.9.0 Added user data, removed the `$settings` parameter,
+         *              added the `$origin` parameter.
          *
          * @param string $origin Optional. To what level should we merge data.
-         *                       Valid values are 'theme' or 'custom'.
-         *                       Default is 'custom'.
+         *                       Valid values are 'theme' or 'custom'. Default 'custom'.
          * @return WP_Theme_JSON
          */
         public static function get_merged_data( $origin = 'custom' ) {
                 if ( is_array( $origin ) ) {
-                        _deprecated_argument( __FUNCTION__, '5.9' );
+                        _deprecated_argument( __FUNCTION__, '5.9.0' );
                 }
 
@@ -397 +398 @@
          *
          * @since 5.8.0
-         * @since 5.9.0 Also check in the parent theme.
+         * @since 5.9.0 Added a check in the parent theme.
          *
          * @return bool
@@ -418 +419 @@
          *
          * @since 5.8.0
-         * @since 5.9.0 Adapt to work with child themes.
+         * @since 5.9.0 Adapted to work with child themes, added the `$template` argument.
          *
          * @param string $file_name Name of the file.
@@ -435 +436 @@
          *
          * @since 5.8.0
-         * @since 5.9.0 Added new variables to reset.
+         * @since 5.9.0 Added the `$user`, `$user_custom_post_type_id`,
+         *              and `$i18n_schema` variables to reset.
          */
         public static function clean_cached_data() {