<!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>[56585] trunk: Taxonomy: Introduce 'cache_results' parameter to WP_Term_Query for bypassing query caching.</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/56585">56585</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/56585","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-09-14 12:38:04 +0000 (Thu, 14 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'>Taxonomy: Introduce 'cache_results' parameter to WP_Term_Query for bypassing query caching.
Incorporating a new 'cache_results' parameter into the WP_Term_Query class, this commit empowers developers with the ability to bypass query caches, explicitly triggering database queries when needed. This brings the `WP_Term_Query` class inline with `WP_Query` and `WP_User_Query` that already have a 'cache_results' parameter.
Update the `term_exists` function to use this new parameter, so the term query caches are not used while importing.
Props dlh, spacedmonkey, peterwilsoncc.
Fixes <a href="https://core.trac.wordpress.org/ticket/52710">#52710</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswptermqueryphp">trunk/src/wp-includes/class-wp-term-query.php</a></li>
<li><a href="#trunksrcwpincludestaxonomyphp">trunk/src/wp-includes/taxonomy.php</a></li>
<li><a href="#trunktestsphpunitteststermgetTermsphp">trunk/tests/phpunit/tests/term/getTerms.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswptermqueryphp"></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-term-query.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-term-query.php 2023-09-14 11:45:51 UTC (rev 56584)
+++ trunk/src/wp-includes/class-wp-term-query.php 2023-09-14 12:38:04 UTC (rev 56585)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -91,6 +91,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.9.0 Added 'slug__in' support for 'orderby'.
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.1.0 Introduced the 'meta_compare_key' parameter.
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.3.0 Introduced the 'meta_type_key' parameter.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.4.0 Introduced the 'cache_results' parameter.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|array $query {
</span><span class="cx" style="display: block; padding: 0 10px"> * Optional. Array or query string of term query parameters. Default empty.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -178,6 +179,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Default false.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $cache_domain Unique cache key to be produced when this query is stored in
</span><span class="cx" style="display: block; padding: 0 10px"> * an object cache. Default 'core'.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type bool $cache_results Whether to cache term information. Default true.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @type bool $update_term_meta_cache Whether to prime meta caches for matched terms. Default true.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string|string[] $meta_key Meta key or keys to filter by.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string|string[] $meta_value Meta value or values to filter by.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -220,6 +222,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'parent' => '',
</span><span class="cx" style="display: block; padding: 0 10px"> 'childless' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> 'cache_domain' => 'core',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'cache_results' => true,
</ins><span class="cx" style="display: block; padding: 0 10px"> 'update_term_meta_cache' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> 'meta_query' => '',
</span><span class="cx" style="display: block; padding: 0 10px"> 'meta_key' => '',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -776,34 +779,38 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $this->terms;
</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">- $cache_key = $this->generate_cache_key( $args, $this->request );
- $cache = wp_cache_get( $cache_key, 'term-queries' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $args['cache_results'] ) {
+ $cache_key = $this->generate_cache_key( $args, $this->request );
+ $cache = wp_cache_get( $cache_key, 'term-queries' );
</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 ( false !== $cache ) {
- if ( 'ids' === $_fields ) {
- $cache = array_map( 'intval', $cache );
- } elseif ( 'count' !== $_fields ) {
- if ( ( 'all_with_object_id' === $_fields && ! empty( $args['object_ids'] ) )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( false !== $cache ) {
+ if ( 'ids' === $_fields ) {
+ $cache = array_map( 'intval', $cache );
+ } elseif ( 'count' !== $_fields ) {
+ if ( ( 'all_with_object_id' === $_fields && ! empty( $args['object_ids'] ) )
</ins><span class="cx" style="display: block; padding: 0 10px"> || ( 'all' === $_fields && $args['pad_counts'] || $fields_is_filtered )
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- ) {
- $term_ids = wp_list_pluck( $cache, 'term_id' );
- } else {
- $term_ids = array_map( 'intval', $cache );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ ) {
+ $term_ids = wp_list_pluck( $cache, 'term_id' );
+ } else {
+ $term_ids = array_map( 'intval', $cache );
+ }
+
+ _prime_term_caches( $term_ids, $args['update_term_meta_cache'] );
+
+ $term_objects = $this->populate_terms( $cache );
+ $cache = $this->format_terms( $term_objects, $_fields );
</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">- _prime_term_caches( $term_ids, $args['update_term_meta_cache'] );
-
- $term_objects = $this->populate_terms( $cache );
- $cache = $this->format_terms( $term_objects, $_fields );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->terms = $cache;
+ return $this->terms;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
- $this->terms = $cache;
- return $this->terms;
</del><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"> if ( 'count' === $_fields ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $count = $wpdb->get_var( $this->request ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- wp_cache_set( $cache_key, $count, 'term-queries' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $args['cache_results'] ) {
+ wp_cache_set( $cache_key, $count, 'term-queries' );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> return $count;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -810,7 +817,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $terms = $wpdb->get_results( $this->request ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $terms ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- wp_cache_add( $cache_key, array(), 'term-queries' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $args['cache_results'] ) {
+ wp_cache_add( $cache_key, array(), 'term-queries' );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> return array();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -892,7 +901,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $term_cache = wp_list_pluck( $term_objects, 'term_id' );
</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_cache_add( $cache_key, $term_cache, 'term-queries' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $args['cache_results'] ) {
+ wp_cache_add( $cache_key, $term_cache, 'term-queries' );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->terms = $this->format_terms( $term_objects, $_fields );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $this->terms;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1153,7 +1165,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // $args can be anything. Only use the args defined in defaults to compute the key.
</span><span class="cx" style="display: block; padding: 0 10px"> $cache_args = wp_array_slice_assoc( $args, array_keys( $this->query_var_defaults ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- unset( $cache_args['update_term_meta_cache'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ unset( $cache_args['cache_results'], $cache_args['update_term_meta_cache'] );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'count' !== $args['fields'] && 'all_with_object_id' !== $args['fields'] ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $cache_args['fields'] = 'all';
</span></span></pre></div>
<a id="trunksrcwpincludestaxonomyphp"></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/taxonomy.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/taxonomy.php 2023-09-14 11:45:51 UTC (rev 56584)
+++ trunk/src/wp-includes/taxonomy.php 2023-09-14 12:38:04 UTC (rev 56585)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1541,8 +1541,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Ensure that while importing, queries are not cached.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $_wp_suspend_cache_invalidation ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // @todo Disable caching once #52710 is merged.
- $defaults['cache_domain'] = microtime();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $defaults['cache_results'] = false;
</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"> if ( ! empty( $taxonomy ) ) {
</span></span></pre></div>
<a id="trunktestsphpunitteststermgetTermsphp"></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/term/getTerms.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/term/getTerms.php 2023-09-14 11:45:51 UTC (rev 56584)
+++ trunk/tests/phpunit/tests/term/getTerms.php 2023-09-14 12:38:04 UTC (rev 56585)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3026,6 +3026,39 @@
</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">+ * @ticket 52710
+ */
+ public function test_get_terms_without_update_get_terms_cache() {
+ $this->set_up_three_posts_and_tags();
+
+ $num_queries = get_num_queries();
+
+ // last_changed and num_queries should bump.
+ $terms = get_terms(
+ 'post_tag',
+ array(
+ 'cache_results' => false,
+ 'update_term_meta_cache' => false,
+ )
+ );
+ $this->assertCount( 3, $terms, 'After running get_terms, 3 terms should be returned' );
+ $this->assertSame( $num_queries + 2, get_num_queries(), 'There should be only 2 queries run, only term query and priming terms' );
+
+ $num_queries = get_num_queries();
+
+ // last_changed and num_queries should bump again.
+ $terms = get_terms(
+ 'post_tag',
+ array(
+ 'cache_results' => false,
+ 'update_term_meta_cache' => false,
+ )
+ );
+ $this->assertCount( 3, $terms, 'After running get_terms for a second time, 3 terms should be returned' );
+ $this->assertSame( $num_queries + 1, get_num_queries(), 'On the second run, only run the term query, priming terms happens on the first run' );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 35935
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_hierarchical_offset_exceeds_available_count() {
</span></span></pre>
</div>
</div>
</body>
</html>