<!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>[54186] trunk: Posts, Post Types: Improve performance of the `get_user_data_from_wp_global_styles` method.</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/54186">54186</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/54186","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>2022-09-16 10:55:58 +0000 (Fri, 16 Sep 2022)</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'>Posts, Post Types: Improve performance of the `get_user_data_from_wp_global_styles` method.
Improve the logic found in `get_user_data_from_wp_global_styles` method. Replace call to `wp_get_recent_posts` with the more standard, `WP_Query` for consistancy. Use transient over standard cache, to improve performance on sites without persistent object caching. Improve handling of cases where `wp_insert_post` returns a `WP_Error`.
Props spacedmonkey, adamsilverstein, mukesh27, peterwilsoncc, andregal.
Fixes <a href="https://core.trac.wordpress.org/ticket/55392">#55392</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpthemejsonresolverphp">trunk/src/wp-includes/class-wp-theme-json-resolver.php</a></li>
<li><a href="#trunktestsphpunitteststhemewpThemeJsonResolverphp">trunk/tests/phpunit/tests/theme/wpThemeJsonResolver.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpthemejsonresolverphp"></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/class-wp-theme-json-resolver.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-theme-json-resolver.php 2022-09-15 22:57:52 UTC (rev 54185)
+++ trunk/src/wp-includes/class-wp-theme-json-resolver.php 2022-09-16 10:55:58 UTC (rev 54186)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -304,54 +304,59 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> $user_cpt = array();
</span><span class="cx" style="display: block; padding: 0 10px"> $post_type_filter = 'wp_global_styles';
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $stylesheet = $theme->get_stylesheet();
</ins><span class="cx" style="display: block; padding: 0 10px"> $args = array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'numberposts' => 1,
- 'orderby' => 'date',
- 'order' => 'desc',
- 'post_type' => $post_type_filter,
- 'post_status' => $post_status_filter,
- 'tax_query' => array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'posts_per_page' => 1,
+ 'orderby' => 'post_date',
+ 'order' => 'desc',
+ 'post_type' => $post_type_filter,
+ 'post_status' => $post_status_filter,
+ 'ignore_sticky_posts' => true,
+ 'no_found_rows' => true,
+ 'tax_query' => array(
</ins><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'taxonomy' => 'wp_theme',
</span><span class="cx" style="display: block; padding: 0 10px"> 'field' => 'name',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'terms' => $theme->get_stylesheet(),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'terms' => $stylesheet,
</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 class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $cache_key = sprintf( 'wp_global_styles_%s', md5( serialize( $args ) ) );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $post_id = wp_cache_get( $cache_key );
-
- if ( (int) $post_id > 0 ) {
- return get_post( $post_id, ARRAY_A );
- }
-
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $post_id = (int) get_transient( $cache_key );
</ins><span class="cx" style="display: block; padding: 0 10px"> // Special case: '-1' is a results not found.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( -1 === $post_id && ! $create_post ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return $user_cpt;
</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">- $recent_posts = wp_get_recent_posts( $args );
- if ( is_array( $recent_posts ) && ( count( $recent_posts ) === 1 ) ) {
- $user_cpt = $recent_posts[0];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $post_id > 0 && in_array( get_post_status( $post_id ), (array) $post_status_filter, true ) ) {
+ return get_post( $post_id, ARRAY_A );
+ }
+
+ $global_style_query = new WP_Query();
+ $recent_posts = $global_style_query->query( $args );
+ if ( count( $recent_posts ) === 1 ) {
+ $user_cpt = get_post( $recent_posts[0], ARRAY_A );
</ins><span class="cx" style="display: block; padding: 0 10px"> } elseif ( $create_post ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $cpt_post_id = wp_insert_post(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'post_content' => '{"version": ' . WP_Theme_JSON::LATEST_SCHEMA . ', "isGlobalStylesUserThemeJSON": true }',
</span><span class="cx" style="display: block; padding: 0 10px"> 'post_status' => 'publish',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'post_title' => 'Custom Styles',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'post_title' => __( 'Custom Styles' ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'post_type' => $post_type_filter,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'post_name' => 'wp-global-styles-' . urlencode( wp_get_theme()->get_stylesheet() ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'post_name' => sprintf( 'wp-global-styles-%s', urlencode( $stylesheet ) ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'tax_input' => array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'wp_theme' => array( wp_get_theme()->get_stylesheet() ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'wp_theme' => array( $stylesheet ),
</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"> true
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $user_cpt = get_post( $cpt_post_id, ARRAY_A );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! is_wp_error( $cpt_post_id ) ) {
+ $user_cpt = get_post( $cpt_post_id, ARRAY_A );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> $cache_expiration = $user_cpt ? DAY_IN_SECONDS : HOUR_IN_SECONDS;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- wp_cache_set( $cache_key, $user_cpt ? $user_cpt['ID'] : -1, '', $cache_expiration );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ set_transient( $cache_key, $user_cpt ? $user_cpt['ID'] : -1, $cache_expiration );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $user_cpt;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunitteststhemewpThemeJsonResolverphp"></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/theme/wpThemeJsonResolver.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/theme/wpThemeJsonResolver.php 2022-09-15 22:57:52 UTC (rev 54185)
+++ trunk/tests/phpunit/tests/theme/wpThemeJsonResolver.php 2022-09-16 10:55:58 UTC (rev 54186)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -353,29 +353,81 @@
</span><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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * @covers WP_Theme_JSON_Resolver::get_user_data_from_wp_global_styles
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> function test_get_user_data_from_wp_global_styles_does_not_use_uncached_queries() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $theme = wp_get_theme();
+ WP_Theme_JSON_Resolver::get_user_data_from_wp_global_styles( $theme );
</ins><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'query', array( $this, 'filter_db_query' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $query_count = count( $this->queries );
</span><span class="cx" style="display: block; padding: 0 10px"> for ( $i = 0; $i < 3; $i++ ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- WP_Theme_JSON_Resolver::get_user_data_from_wp_global_styles( wp_get_theme() );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ WP_Theme_JSON_Resolver::get_user_data_from_wp_global_styles( $theme );
</ins><span class="cx" style="display: block; padding: 0 10px"> WP_Theme_JSON_Resolver::clean_cached_data();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> $query_count = count( $this->queries ) - $query_count;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEquals( 1, $query_count, 'Only one SQL query should be peformed for multiple invocations of WP_Theme_JSON_Resolver::get_global_styles_from_post()' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEquals( 0, $query_count, 'Unexpected SQL queries detected for the wp_global_style post type' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $user_cpt = WP_Theme_JSON_Resolver::get_user_data_from_wp_global_styles( wp_get_theme() );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $user_cpt = WP_Theme_JSON_Resolver::get_user_data_from_wp_global_styles( $theme );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertEmpty( $user_cpt );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $user_cpt = WP_Theme_JSON_Resolver::get_user_data_from_wp_global_styles( wp_get_theme(), true );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $user_cpt = WP_Theme_JSON_Resolver::get_user_data_from_wp_global_styles( $theme, true );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertNotEmpty( $user_cpt );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $query_count = count( $this->queries );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- for ( $i = 0; $i < 3; $i++ ) {
- WP_Theme_JSON_Resolver::get_user_data_from_wp_global_styles( wp_get_theme() );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ for ( $i = 0; $i < 3; $i ++ ) {
+ $new_user_cpt = WP_Theme_JSON_Resolver::get_user_data_from_wp_global_styles( $theme );
</ins><span class="cx" style="display: block; padding: 0 10px"> WP_Theme_JSON_Resolver::clean_cached_data();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertSameSets( $user_cpt, $new_user_cpt );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> $query_count = count( $this->queries ) - $query_count;
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 0, $query_count, 'Unexpected SQL queries detected for the wp_global_style post type' );
</span><span class="cx" style="display: block; padding: 0 10px"> remove_filter( 'query', array( $this, 'filter_db_query' ) );
</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 55392
+ * @covers WP_Theme_JSON_Resolver::get_user_data_from_wp_global_styles
+ */
+ function test_get_user_data_from_wp_global_styles_does_exist() {
+ $theme = wp_get_theme();
+ $post1 = WP_Theme_JSON_Resolver::get_user_data_from_wp_global_styles( $theme, true );
+ $this->assertIsArray( $post1 );
+ $this->assertArrayHasKey( 'ID', $post1 );
+ wp_delete_post( $post1['ID'], true );
+ $post2 = WP_Theme_JSON_Resolver::get_user_data_from_wp_global_styles( $theme, true );
+ $this->assertIsArray( $post2 );
+ $this->assertArrayHasKey( 'ID', $post2 );
+ }
+
+ /**
+ * @ticket 55392
+ * @covers WP_Theme_JSON_Resolver::get_user_data_from_wp_global_styles
+ */
+ function test_get_user_data_from_wp_global_styles_create_post() {
+ $theme = wp_get_theme( 'testing' );
+ $post1 = WP_Theme_JSON_Resolver::get_user_data_from_wp_global_styles( $theme );
+ $this->assertIsArray( $post1 );
+ $this->assertSameSets( array(), $post1 );
+ $post2 = WP_Theme_JSON_Resolver::get_user_data_from_wp_global_styles( $theme );
+ $this->assertIsArray( $post2 );
+ $this->assertSameSets( array(), $post2 );
+ $post3 = WP_Theme_JSON_Resolver::get_user_data_from_wp_global_styles( $theme, true );
+ $this->assertIsArray( $post3 );
+ $this->assertArrayHasKey( 'ID', $post3 );
+ }
+
+ /**
+ * @ticket 55392
+ * @covers WP_Theme_JSON_Resolver::get_user_data_from_wp_global_styles
+ */
+ function test_get_user_data_from_wp_global_styles_filter_state() {
+ $theme = wp_get_theme( 'foo' );
+ $post1 = WP_Theme_JSON_Resolver::get_user_data_from_wp_global_styles( $theme, true, array( 'publish' ) );
+ $this->assertIsArray( $post1 );
+ $this->assertArrayHasKey( 'ID', $post1 );
+ $post2 = WP_Theme_JSON_Resolver::get_user_data_from_wp_global_styles( $theme, false, array( 'draft' ) );
+ $this->assertIsArray( $post2 );
+ $this->assertSameSets( array(), $post2 );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>