<!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>[55888] trunk: Script Loader: Improve performance of wp_maybe_inline_styles function.</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/55888">55888</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/55888","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>spacedmonkey</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-06-07 06:54:18 +0000 (Wed, 07 Jun 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'>Script Loader: Improve performance of wp_maybe_inline_styles function.
The `wp_maybe_inline_styles` function is called twice on the average page load. On it's second run however, it did not check to see if the style had already been processed on the first run. This resulted in calling `filesize` and `get_file_contents` unnecessarily, which was bad for performance. Now, the loop around the queued styles, checks to see if the source is set to false, meaning it has already been processed. This change also replaces calls to `filesize` with the core function `wp_filesize`, which improves extensibility.
Props spacedmonkey, flixos90, peterwilsoncc, joemcgill.
Fixes <a href="https://core.trac.wordpress.org/ticket/58394">#58394</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesscriptloaderphp">trunk/src/wp-includes/script-loader.php</a></li>
<li><a href="#trunktestsphpunittestsdependenciesstylesphp">trunk/tests/phpunit/tests/dependencies/styles.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesscriptloaderphp"></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/script-loader.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/script-loader.php 2023-06-07 06:51:53 UTC (rev 55887)
+++ trunk/src/wp-includes/script-loader.php 2023-06-07 06:54:18 UTC (rev 55888)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2872,12 +2872,18 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Build an array of styles that have a path defined.
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $wp_styles->queue as $handle ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( wp_styles()->get_data( $handle, 'path' ) && file_exists( $wp_styles->registered[ $handle ]->extra['path'] ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $src = $wp_styles->registered[ $handle ]->src;
+ $path = wp_styles()->get_data( $handle, 'path' );
+ if ( $path && $src ) {
+ $size = wp_filesize( $path );
+ if ( ! $size ) {
+ continue;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> $styles[] = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'handle' => $handle,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'src' => $wp_styles->registered[ $handle ]->src,
- 'path' => $wp_styles->registered[ $handle ]->extra['path'],
- 'size' => filesize( $wp_styles->registered[ $handle ]->extra['path'] ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'src' => $src,
+ 'path' => $path,
+ 'size' => $size,
</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"> }
</span></span></pre></div>
<a id="trunktestsphpunittestsdependenciesstylesphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/dependencies/styles.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/dependencies/styles.php 2023-06-07 06:51:53 UTC (rev 55887)
+++ trunk/tests/phpunit/tests/dependencies/styles.php 2023-06-07 06:54:18 UTC (rev 55888)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -517,4 +517,99 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $GLOBALS['wp_styles']->registered['wp-block-library']->src
</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">+
+ /**
+ * @ticket 58394
+ *
+ * @covers ::wp_maybe_inline_styles
+ */
+ public function test_wp_maybe_inline_styles() {
+ wp_register_style( 'test-handle', '/' . WPINC . '/css/classic-themes.css' );
+ wp_style_add_data( 'test-handle', 'path', ABSPATH . WPINC . '/css/classic-themes.css' );
+
+ wp_enqueue_style( 'test-handle' );
+
+ wp_maybe_inline_styles();
+
+ $this->assertFalse( $GLOBALS['wp_styles']->registered['test-handle']->src, 'Source of style should be reset to false' );
+
+ $css = file_get_contents( ABSPATH . WPINC . '/css/classic-themes.css' );
+ $this->assertSameSets( $GLOBALS['wp_styles']->registered['test-handle']->extra['after'], array( $css ), 'Source of style should set to after property' );
+ }
+
+ /**
+ * wp_filesize should be only be called once, as on the second run of wp_maybe_inline_styles,
+ * src will be set to false and filesize will not be requested.
+ *
+ * @ticket 58394
+ *
+ * @covers ::wp_maybe_inline_styles
+ */
+ public function test_wp_maybe_inline_styles_multiple_runs() {
+ $filter = new MockAction();
+ add_filter( 'pre_wp_filesize', array( $filter, 'filter' ) );
+ wp_register_style( 'test-handle', '/' . WPINC . '/css/classic-themes.css' );
+ wp_style_add_data( 'test-handle', 'path', ABSPATH . WPINC . '/css/classic-themes.css' );
+
+ wp_enqueue_style( 'test-handle' );
+
+ wp_maybe_inline_styles();
+ wp_maybe_inline_styles();
+
+ $this->assertSame( 1, $filter->get_call_count() );
+ }
+
+ /**
+ * @ticket 58394
+ *
+ * @covers ::wp_maybe_inline_styles
+ */
+ public function test_test_wp_maybe_inline_styles_missing_file() {
+ $filter = new MockAction();
+ add_filter( 'pre_wp_filesize', array( $filter, 'filter' ) );
+ $url = '/' . WPINC . '/css/invalid.css';
+ wp_register_style( 'test-handle', $url );
+ wp_style_add_data( 'test-handle', 'path', ABSPATH . WPINC . '/css/invalid.css' );
+
+ wp_enqueue_style( 'test-handle' );
+
+ wp_maybe_inline_styles();
+
+ $this->assertSame( $GLOBALS['wp_styles']->registered['test-handle']->src, $url, 'Source should not change' );
+ $this->assertArrayNotHasKey( 'after', $GLOBALS['wp_styles']->registered['test-handle']->extra, 'Source of style not should set to after property' );
+ $this->assertSame( 1, $filter->get_call_count(), 'wp_filesize should only be called once' );
+ }
+
+ /**
+ * @ticket 58394
+ *
+ * @covers ::wp_maybe_inline_styles
+ */
+ public function test_wp_maybe_inline_styles_no_src() {
+ wp_register_style( 'test-handle', false );
+ wp_style_add_data( 'test-handle', 'path', ABSPATH . WPINC . '/css/classic-themes.css' );
+
+ wp_enqueue_style( 'test-handle' );
+
+ wp_maybe_inline_styles();
+
+ $this->assertFalse( $GLOBALS['wp_styles']->registered['test-handle']->src, 'Source of style should remain false' );
+ $this->assertArrayNotHasKey( 'after', $GLOBALS['wp_styles']->registered['test-handle']->extra, 'Source of style not should set to after property' );
+ }
+
+ /**
+ * @ticket 58394
+ *
+ * @covers ::wp_maybe_inline_styles
+ */
+ public function test_wp_maybe_inline_styles_no_path() {
+ $url = '/' . WPINC . '/css/classic-themes.css';
+ wp_register_style( 'test-handle', $url );
+
+ wp_enqueue_style( 'test-handle' );
+
+ wp_maybe_inline_styles();
+
+ $this->assertSame( $GLOBALS['wp_styles']->registered['test-handle']->src, $url );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>