Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Theme JSON and Resolver: Update block caching logic to clear based on number of registered blocks #3373

Closed
wants to merge 1 commit into from
Closed

Theme JSON and Resolver: Update block caching logic to clear based on number of registered blocks #3373

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 36 additions & 4 deletions src/wp-includes/class-wp-theme-json-resolver.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,15 @@ class WP_Theme_JSON_Resolver {
*/
protected static $theme = null;

/**
* Holds a cache key string, to determine when
* to generate fresh theme data.
*
* @since 6.1.0
* @var string
*/
protected static $theme_cache_key = null;

/**
* Whether or not the theme supports theme.json.
*
Expand Down Expand Up @@ -90,6 +99,25 @@ protected static function read_json_file( $file_path ) {
return $config;
}

/**
* Generates a new cache key to determine when to clear theme cache.
*
* @since 6.1.0
*
* @return string A cache key.
*/
protected static function get_new_theme_cache_key() {
$registry = WP_Block_Type_Registry::get_instance();
$blocks = $registry->get_all_registered();

/*
* Generate the key based on the current number of blocks registered.
* This ensures that Theme JSON data accessed at registration time
* does not result in stale block data.
*/
return 'registered-blocks-' . count( $blocks );
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can this result in a case where we end up with the same number of blocks but they're different? Perhaps we could get a hash of the $blocks array instead.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, that seems to be a concern shared by some folks: #3373 (comment)

Copy link

@ajlende ajlende Oct 4, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately we can't rely on only the registered block names because there is at least one instance where we unregister an old version of a block and re-register a new one with the same name within the same function.

#3373 (comment)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately we can't rely on only the registered block names because there is at least one instance where we unregister an old version of a block and re-register a new one with the same name within the same function.

Thank you for pointing that out! I just tried to address that at #3359 (comment).

}

/**
* Returns a data structure used in theme.json translation.
*
Expand Down Expand Up @@ -162,6 +190,7 @@ public static function get_core_data() {
* @since 5.8.0
* @since 5.9.0 Theme supports have been inlined and the `$theme_support_data` argument removed.
* @since 6.0.0 Added an `$options` parameter to allow the theme data to be returned without theme supports.
* @since 6.1.0 Clear `$theme` cache if number of registered blocks has changed.
*
* @param array $deprecated Deprecated. Not used.
* @param array $options {
Expand All @@ -176,11 +205,13 @@ public static function get_theme_data( $deprecated = array(), $options = array()
_deprecated_argument( __METHOD__, '5.9.0' );
}

$options = wp_parse_args( $options, array( 'with_supports' => true ) );
$options = wp_parse_args( $options, array( 'with_supports' => true ) );
$new_cache_key = static::get_new_theme_cache_key();

if ( null === static::$theme ) {
$theme_json_data = static::read_json_file( static::get_file_path_from_theme( 'theme.json' ) );
$theme_json_data = static::translate( $theme_json_data, wp_get_theme()->get( 'TextDomain' ) );
if ( null === static::$theme || $new_cache_key !== static::$theme_cache_key ) {
static::$theme_cache_key = $new_cache_key;
$theme_json_data = static::read_json_file( static::get_file_path_from_theme( 'theme.json' ) );
$theme_json_data = static::translate( $theme_json_data, wp_get_theme()->get( 'TextDomain' ) );
/**
* Filters the data provided by the theme for global styles & settings.
*
Expand Down Expand Up @@ -560,6 +591,7 @@ protected static function get_file_path_from_theme( $file_name, $template = fals
public static function clean_cached_data() {
static::$core = null;
static::$theme = null;
static::$theme_cache_key = null;
static::$user = null;
static::$user_custom_post_type_id = null;
static::$theme_has_support = null;
Expand Down
34 changes: 32 additions & 2 deletions src/wp-includes/class-wp-theme-json.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,15 @@ class WP_Theme_JSON {
*/
protected static $blocks_metadata = null;

/**
* Holds a cache key string, to determine when
* to generate fresh block data.
*
* @since 6.1.0
* @var string
*/
protected static $blocks_cache_key = null;

/**
* The CSS selector for the top-level styles.
*
Expand Down Expand Up @@ -690,6 +699,25 @@ protected static function append_to_selector( $selector, $to_append, $position =
return implode( ',', $new_selectors );
}

/**
* Generates a new cache key to determine when to clear blocks cache.
*
* @since 6.1.0
*
* @return string A cache key.
*/
protected static function get_new_blocks_cache_key() {
$registry = WP_Block_Type_Registry::get_instance();
$blocks = $registry->get_all_registered();

/*
* Generate the key based on the current number of blocks registered.
* This ensures that Theme JSON data accessed at registration time
* does not result in stale block data.
*/
return 'registered-blocks-' . count( $blocks );
}

/**
* Returns the metadata for each block.
*
Expand Down Expand Up @@ -721,11 +749,13 @@ protected static function append_to_selector( $selector, $to_append, $position =
* @return array Block metadata.
*/
protected static function get_blocks_metadata() {
if ( null !== static::$blocks_metadata ) {
$new_cache_key = static::get_new_blocks_cache_key();
if ( null !== static::$blocks_metadata && $new_cache_key === static::$blocks_cache_key ) {
return static::$blocks_metadata;
}

static::$blocks_metadata = array();
static::$blocks_cache_key = $new_cache_key;
static::$blocks_metadata = array();

$registry = WP_Block_Type_Registry::get_instance();
$blocks = $registry->get_all_registered();
Expand Down