<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[56524] trunk/src/wp-includes/blocks/index.php: Themes: Avoid stale caches for core block styles.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/56524">56524</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/56524","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>joemcgill</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-09-06 18:06:47 +0000 (Wed, 06 Sep 2023)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Themes: Avoid stale caches for core block styles.
This fixes an issue introduced in <a href="https://core.trac.wordpress.org/changeset/56044">[56044]</a> in which the path to core block styles are cached to avoid expensive file operations on every page load. The original caching strategy is now modified so that only the path relative to the blocks location are stored, rather than the full path, since the path to the `wp-includes` folder can change after the value is generated. The new cached value also includes the current WordPress version value to ensure it is rebuilt when the version changes.
Props lhe2012, coreyw, colorful tones, petitphp, mukesh27, spacedmonkey, joemcgill, flixos90, kimannwall, desmith.
Fixes <a href="https://core.trac.wordpress.org/ticket/59111">#59111</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesblocksindexphp">trunk/src/wp-includes/blocks/index.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesblocksindexphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/blocks/index.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/blocks/index.php 2023-09-06 12:58:47 UTC (rev 56523)
+++ trunk/src/wp-includes/blocks/index.php 2023-09-06 18:06:47 UTC (rev 56524)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -20,46 +20,78 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * avoids unnecessary logic and filesystem lookups in the other function.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.3.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @global string $wp_version The WordPress version string.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function register_core_block_style_handles() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ global $wp_version;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! wp_should_load_separate_core_block_assets() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $blocks_url = includes_url( 'blocks/' );
+ $suffix = wp_scripts_get_suffix();
+ $wp_styles = wp_styles();
+ $style_fields = array(
+ 'style' => 'style',
+ 'editorStyle' => 'editor',
+ );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> static $core_blocks_meta;
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $core_blocks_meta ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $core_blocks_meta = require ABSPATH . WPINC . '/blocks/blocks-json.php';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $core_blocks_meta = require BLOCKS_PATH . 'blocks-json.php';
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $includes_url = includes_url();
- $includes_path = ABSPATH . WPINC . '/';
- $suffix = wp_scripts_get_suffix();
- $wp_styles = wp_styles();
- $style_fields = array(
- 'style' => 'style',
- 'editorStyle' => 'editor',
- );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $files = false;
+ $transient_name = 'wp_core_block_css_files';
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /*
</span><span class="cx" style="display: block; padding: 0 10px"> * Ignore transient cache when the development mode is set to 'core'. Why? To avoid interfering with
</span><span class="cx" style="display: block; padding: 0 10px"> * the core developer's workflow.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! wp_is_development_mode( 'core' ) ) {
- $transient_name = 'wp_core_block_css_files';
- $files = get_transient( $transient_name );
- if ( ! $files ) {
- $files = glob( wp_normalize_path( __DIR__ . '/**/**.css' ) );
- set_transient( $transient_name, $files );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $can_use_cached = ! wp_is_development_mode( 'core' );
+
+ if ( $can_use_cached ) {
+ $cached_files = get_transient( $transient_name );
+
+ // Check the validity of cached values by checking against the current WordPress version.
+ if (
+ is_array( $cached_files )
+ && isset( $cached_files['version'] )
+ && $cached_files['version'] === $wp_version
+ && isset( $cached_files['files'] )
+ ) {
+ $files = $cached_files['files'];
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- } else {
- $files = glob( wp_normalize_path( __DIR__ . '/**/**.css' ) );
</del><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $register_style = static function( $name, $filename, $style_handle ) use ( $includes_path, $includes_url, $suffix, $wp_styles, $files ) {
- $style_path = "blocks/{$name}/{$filename}{$suffix}.css";
- $path = wp_normalize_path( $includes_path . $style_path );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! $files ) {
+ $files = glob( wp_normalize_path( BLOCKS_PATH . '**/**.css' ) );
+ $files = array_map(
+ static function ( $file ) {
+ return str_replace( BLOCKS_PATH, '', $file );
+ },
+ $files
+ );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! in_array( $path, $files, true ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Save core block style paths in cache when not in development mode.
+ if ( $can_use_cached ) {
+ set_transient(
+ $transient_name,
+ array(
+ 'version' => $wp_version,
+ 'files' => $files,
+ )
+ );
+ }
+ }
+
+ $register_style = static function( $name, $filename, $style_handle ) use ( $blocks_url, $suffix, $wp_styles, $files ) {
+ $style_path = "{$name}/{$filename}{$suffix}.css";
+ $path = wp_normalize_path( BLOCKS_PATH . $style_path );
+
+ if ( ! in_array( $style_path, $files, true ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $wp_styles->add(
</span><span class="cx" style="display: block; padding: 0 10px"> $style_handle,
</span><span class="cx" style="display: block; padding: 0 10px"> false
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -67,7 +99,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $wp_styles->add( $style_handle, $includes_url . $style_path );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $wp_styles->add( $style_handle, $blocks_url . $style_path );
</ins><span class="cx" style="display: block; padding: 0 10px"> $wp_styles->add_data( $style_handle, 'path', $path );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $rtl_file = str_replace( "{$suffix}.css", "-rtl{$suffix}.css", $path );
</span></span></pre>
</div>
</div>
</body>
</html>