Changeset 51284 for trunk

Timestamp:

06/30/2021 05:19:59 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve documentation for optional parameters in WP_Theme_JSON_Resolver methods per the documentation standards.

Move add_action() call to wp-includes/default-filters.php.

Follow-up to [50959], [51221].

See #52628, #53461.

Location:

trunk/src/wp-includes

Files:

• blocks.php (modified) (1 diff)
• class-wp-theme-json-resolver.php (modified) (4 diffs)
• default-filters.php (modified) (1 diff)

trunk/src/wp-includes/blocks.php

@@ -220 +220 @@
     $metadata = apply_filters( 'block_type_metadata', $metadata );
 
-    /**
-     * Add `style` and `editor_style` for core blocks if missing.
-     */
+    // Add `style` and `editor_style` for core blocks if missing.
     if ( ! empty( $metadata['name'] ) && 0 === strpos( $metadata['name'], 'core/' ) ) {
         $block_name = str_replace( 'core/', '', $metadata['name'] );

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

@@ -113 +113 @@
      *
      * @param array $i18n_partial A tree that follows the format of i18n-theme.json.
-     * @param array $current_path Keeps track of the path as we walk down the given tree.
+     * @param array $current_path Optional. Keeps track of the path as we walk down the given tree.
+     *                            Default empty array.
      * @return array A linear array containing the paths to translate.
      */
@@ -266 +267 @@
      * @since 5.8.0
      *
-     * @param array $theme_support_data Theme support data in theme.json format. Default empty array.
+     * @param array $theme_support_data Optional. Theme support data in theme.json format.
+     *                                  Default empty array.
      * @return WP_Theme_JSON Entity that holds theme data.
      */
@@ -302 +304 @@
      * @since 5.8.0
      *
-     * @param array $settings Existing block editor settings.
-     *                         Empty array by default.
+     * @param array $settings Optional. Existing block editor settings. Default empty array.
      * @return WP_Theme_JSON
      */
@@ -370 +371 @@
 
 }
-
-add_action( 'switch_theme', array( 'WP_Theme_JSON_Resolver', 'clean_cached_data' ) );

trunk/src/wp-includes/default-filters.php

@@ -336 +336 @@
 add_action( 'init', 'check_theme_switched', 99 );
 add_action( 'init', array( 'WP_Block_Supports', 'init' ), 22 );
+add_action( 'switch_theme', array( 'WP_Theme_JSON_Resolver', 'clean_cached_data' ) );
 add_action( 'after_switch_theme', '_wp_menus_changed' );
 add_action( 'after_switch_theme', '_wp_sidebars_changed' );