<!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>[37573] trunk: Store only term IDs in object term relationships caches.</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 { 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/37573">37573</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/37573","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>boonebgorges</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-05-26 04:49:10 +0000 (Thu, 26 May 2016)</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'>Store only term IDs in object term relationships caches.
Previously, objects containing all data about a term were stored in each
object's term cache. Besides being wasteful, this approach caused invalidation
issues, as when a modified term count required a flush for all objects
belonging to the term.
Backward compatibility is maintained for plugins that continue to put object
data directly into the `{$taxonomy}_relationships` cache bucket.
Fixes <a href="https://core.trac.wordpress.org/ticket/36814">#36814</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludestaxonomyphp">trunk/src/wp-admin/includes/taxonomy.php</a></li>
<li><a href="#trunksrcwpadminincludestemplatephp">trunk/src/wp-admin/includes/template.php</a></li>
<li><a href="#trunksrcwpincludescategorytemplatephp">trunk/src/wp-includes/category-template.php</a></li>
<li><a href="#trunksrcwpincludestaxonomyphp">trunk/src/wp-includes/taxonomy.php</a></li>
<li><a href="#trunktestsphpunitteststermgetTheTermsphp">trunk/tests/phpunit/tests/term/getTheTerms.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludestaxonomyphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/taxonomy.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/taxonomy.php 2016-05-26 04:32:30 UTC (rev 37572)
+++ trunk/src/wp-admin/includes/taxonomy.php 2016-05-26 04:49:10 UTC (rev 37573)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -242,7 +242,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $terms = get_object_term_cache( $post_id, $taxonomy );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( false === $terms ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $terms = wp_get_object_terms( $post_id, $taxonomy );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- wp_cache_add( $post_id, $terms, $taxonomy . '_relationships' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ wp_cache_add( $post_id, wp_list_pluck( $terms, 'term_id' ), $taxonomy . '_relationships' );
</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 ( ! $terms ) {
</span></span></pre></div>
<a id="trunksrcwpadminincludestemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/template.php 2016-05-26 04:32:30 UTC (rev 37572)
+++ trunk/src/wp-admin/includes/template.php 2016-05-26 04:49:10 UTC (rev 37573)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -311,7 +311,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $terms = get_object_term_cache( $post->ID, $taxonomy_name );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( false === $terms ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $terms = wp_get_object_terms( $post->ID, $taxonomy_name );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- wp_cache_add( $post->ID, $terms, $taxonomy_name . '_relationships' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ wp_cache_add( $post->ID, wp_list_pluck( $terms, 'term_id' ), $taxonomy_name . '_relationships' );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> $term_ids = empty( $terms ) ? array() : wp_list_pluck( $terms, 'term_id' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunksrcwpincludescategorytemplatephp"></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/category-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/category-template.php 2016-05-26 04:32:30 UTC (rev 37572)
+++ trunk/src/wp-includes/category-template.php 2016-05-26 04:49:10 UTC (rev 37573)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1187,18 +1187,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( false === $terms ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $terms = wp_get_object_terms( $post->ID, $taxonomy );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_wp_error( $terms ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $to_cache = array();
- foreach ( $terms as $key => $term ) {
- $to_cache[ $key ] = $term->data;
- }
- wp_cache_add( $post->ID, $to_cache, $taxonomy . '_relationships' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $term_ids = wp_list_pluck( $terms, 'term_id' );
+ wp_cache_add( $post->ID, $term_ids, $taxonomy . '_relationships' );
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! is_wp_error( $terms ) ) {
- $terms = array_map( 'get_term', $terms );
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the list of terms attached to the given post.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</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 2016-05-26 04:32:30 UTC (rev 37572)
+++ trunk/src/wp-includes/taxonomy.php 2016-05-26 04:49:10 UTC (rev 37573)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3239,15 +3239,42 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Retrieves the taxonomy relationship to the term object id.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Upstream functions (like `get_the_terms()` and `is_object_in_term()`) are responsible for populating the
+ * object-term relationship cache. The current function only fetches relationship data that is already in the cache.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 2.3.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $id Term object ID.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $taxonomy Taxonomy name.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return bool|mixed Empty array if $terms found, but not `$taxonomy`. False if nothing is in cache
- * for `$taxonomy` and `$id`.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool|array Array of `WP_Term` objects, if cached False if cache is empty for `$taxonomy` and `$id`.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_object_term_cache( $id, $taxonomy ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return wp_cache_get( $id, "{$taxonomy}_relationships" );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $_term_ids = wp_cache_get( $id, "{$taxonomy}_relationships" );
+
+ // We leave the priming of relationship caches to upstream functions.
+ if ( false === $_term_ids ) {
+ return false;
+ }
+
+ // Backward compatibility for if a plugin is putting objects into the cache, rather than IDs.
+ $term_ids = array();
+ foreach ( $_term_ids as $term_id ) {
+ if ( is_numeric( $term_id ) ) {
+ $term_ids[] = intval( $term_id );
+ } elseif ( isset( $term_id->term_id ) ) {
+ $term_ids[] = intval( $term_id->term_id );
+ }
+ }
+
+ // Fill the term objects.
+ _prime_term_caches( $term_ids );
+
+ $terms = array();
+ foreach ( $term_ids as $term_id ) {
+ $terms[] = wp_cache_get( $term_id, 'terms' );
+ }
+
+ return array_map( 'get_term', $terms );
</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="lines" style="display: block; padding: 0 10px; color: #888">@@ -3297,8 +3324,9 @@
</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"> $object_terms = array();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- foreach ( (array) $terms as $term )
- $object_terms[$term->object_id][$term->taxonomy][] = $term;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ foreach ( (array) $terms as $term ) {
+ $object_terms[ $term->object_id ][ $term->taxonomy ][] = $term->term_id;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $ids as $id ) {
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $taxonomies as $taxonomy ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3504,6 +3532,32 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $terms_by_id[$id]->count = count($items);
</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">+/**
+ * Adds any terms from the given IDs to the cache that do not already exist in cache.
+ *
+ * @since 4.6.0
+ * @access private
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param array $term_ids Array of term IDs.
+ * @param bool $update_meta_cache Optional. Whether to update the meta cache. Default true.
+ */
+function _prime_term_caches( $term_ids, $update_meta_cache = true ) {
+ global $wpdb;
+
+ $non_cached_ids = _get_non_cached_ids( $term_ids, 'terms' );
+ if ( ! empty( $non_cached_ids ) ) {
+ $fresh_terms = $wpdb->get_results( sprintf( "SELECT t.*, tt.* FROM $wpdb->terms AS t INNER JOIN $wpdb->term_taxonomy AS tt ON t.term_id = tt.term_id WHERE t.term_id IN (%s)", join( ",", array_map( 'intval', $non_cached_ids ) ) ) );
+
+ update_term_cache( $fresh_terms, $update_meta_cache );
+
+ if ( $update_meta_cache ) {
+ update_termmeta_cache( $non_cached_ids );
+ }
+ }
+}
+
</ins><span class="cx" style="display: block; padding: 0 10px"> //
</span><span class="cx" style="display: block; padding: 0 10px"> // Default callbacks
</span><span class="cx" style="display: block; padding: 0 10px"> //
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4211,7 +4265,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $object_terms = get_object_term_cache( $object_id, $taxonomy );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( false === $object_terms ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $object_terms = wp_get_object_terms( $object_id, $taxonomy, array( 'update_term_meta_cache' => false ) );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- wp_cache_set( $object_id, $object_terms, "{$taxonomy}_relationships" );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ wp_cache_set( $object_id, wp_list_pluck( $object_terms, 'term_id' ), "{$taxonomy}_relationships" );
</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 ( is_wp_error( $object_terms ) )
</span></span></pre></div>
<a id="trunktestsphpunitteststermgetTheTermsphp"></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/getTheTerms.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/term/getTheTerms.php 2016-05-26 04:32:30 UTC (rev 37572)
+++ trunk/tests/phpunit/tests/term/getTheTerms.php 2016-05-26 04:49:10 UTC (rev 37573)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -78,25 +78,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 34262
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function test_get_the_terms_should_not_cache_wp_term_objects() {
- $p = self::$post_ids[0];
- register_taxonomy( 'wptests_tax', 'post' );
- $t = self::factory()->term->create( array( 'taxonomy' => 'wptests_tax' ) );
- wp_set_object_terms( $p, $t, 'wptests_tax' );
-
- // Prime the cache.
- $terms = get_the_terms( $p, 'wptests_tax' );
-
- $cached = get_object_term_cache( $p, 'wptests_tax' );
-
- $this->assertNotEmpty( $cached );
- $this->assertSame( $t, (int) $cached[0]->term_id );
- $this->assertNotInstanceOf( 'WP_Term', $cached[0] );
- }
-
- /**
- * @ticket 34262
- */
</del><span class="cx" style="display: block; padding: 0 10px"> public function test_get_the_terms_should_return_wp_term_objects_from_cache() {
</span><span class="cx" style="display: block; padding: 0 10px"> $p = self::$post_ids[0];
</span><span class="cx" style="display: block; padding: 0 10px"> register_taxonomy( 'wptests_tax', 'post' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -170,4 +151,50 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $terms = get_the_terms( $p, 'this-taxonomy-does-not-exist' );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertTrue( is_wp_error( $terms ) );
</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 36814
+ */
+ public function test_count_should_not_be_improperly_cached() {
+ register_taxonomy( 'wptests_tax', 'post' );
+
+ $t = self::factory()->term->create( array( 'taxonomy' => 'wptests_tax' ) );
+
+ wp_set_object_terms( self::$post_ids[0], $t, 'wptests_tax' );
+
+ $terms = get_the_terms( self::$post_ids[0], 'wptests_tax' );
+ $this->assertSame( 1, $terms[0]->count );
+
+ wp_set_object_terms( self::$post_ids[1], $t, 'wptests_tax' );
+
+ $terms = get_the_terms( self::$post_ids[0], 'wptests_tax' );
+ $this->assertSame( 2, $terms[0]->count );
+ }
+
+ /**
+ * @ticket 36814
+ */
+ public function test_uncached_terms_should_be_primed_with_a_single_query() {
+ global $wpdb;
+
+ register_taxonomy( 'wptests_tax', 'post' );
+
+ $terms = self::factory()->term->create_many( 3, array( 'taxonomy' => 'wptests_tax' ) );
+
+ wp_set_object_terms( self::$post_ids[0], $terms, 'wptests_tax' );
+
+ get_the_terms( self::$post_ids[0], 'wptests_tax' );
+
+ // Clean cache for two of the terms.
+ clean_term_cache( array( $terms[0], $terms[1] ), 'wptests_tax', false );
+
+ $num_queries = $wpdb->num_queries;
+ $found = get_the_terms( self::$post_ids[0], 'wptests_tax' );
+
+ $this->assertEqualSets( $terms, wp_list_pluck( $found, 'term_id' ) );
+
+ $num_queries++;
+ $this->assertSame( $num_queries, $wpdb->num_queries );
+
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>