<!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>[27101] trunk: Add cache invalidation when updating a term, example: create a category, assign it to a post, edit the category.</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">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/27101">27101</a></dd>
<dt>Author</dt> <dd>wonderboymusic</dd>
<dt>Date</dt> <dd>2014-02-06 01:40:05 +0000 (Thu, 06 Feb 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Add cache invalidation when updating a term, example: create a category, assign it to a post, edit the category. Currently, the post's term cache is not updated. When updating terms in a given taxonomy, invalidate the object term caches linked to that taxonomy.
Introduce `get_taxonomy_last_changed()`, `set_taxonomy_last_changed()`, and `post_taxonomy_is_fresh()`.
`post_taxonomy_is_fresh()` is only called in `get_object_term_cache()` - at which point the taxonomy's `last_changed` value is checked against the post's `{$taxonomy}_last_changed` value.
`set_taxonomy_last_changed()` is called whenever directory database queries are made that insert new terms or affect existing terms.
Fixes <a href="http://core.trac.wordpress.org/ticket/22526">#22526</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludestaxonomyphp">trunk/src/wp-includes/taxonomy.php</a></li>
<li><a href="#trunktestsphpunitteststermphp">trunk/tests/phpunit/tests/term.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludestaxonomyphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/taxonomy.php (27100 => 27101)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/taxonomy.php 2014-02-05 05:16:22 UTC (rev 27100)
+++ trunk/src/wp-includes/taxonomy.php 2014-02-06 01:40:05 UTC (rev 27101)
</span><span class="lines">@@ -1876,6 +1876,7 @@
</span><span class="cx"> do_action( 'edit_term_taxonomies', $edit_tt_ids );
</span><span class="cx"> $wpdb->update( $wpdb->term_taxonomy, compact( 'parent' ), array( 'parent' => $term_obj->term_id) + compact( 'taxonomy' ) );
</span><span class="cx"> do_action( 'edited_term_taxonomies', $edit_tt_ids );
</span><ins>+ set_taxonomy_last_changed( $taxonomy );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> $objects = $wpdb->get_col( $wpdb->prepare( "SELECT object_id FROM $wpdb->term_relationships WHERE term_taxonomy_id = %d", $tt_id ) );
</span><span class="lines">@@ -1910,6 +1911,7 @@
</span><span class="cx"> $wpdb->delete( $wpdb->terms, array( 'term_id' => $term ) );
</span><span class="cx">
</span><span class="cx"> clean_term_cache($term, $taxonomy);
</span><ins>+ set_taxonomy_last_changed( $taxonomy );
</ins><span class="cx">
</span><span class="cx"> do_action( 'delete_term', $term, $tt_id, $taxonomy, $deleted_term );
</span><span class="cx"> do_action( "delete_$taxonomy", $term, $tt_id, $deleted_term );
</span><span class="lines">@@ -2162,6 +2164,7 @@
</span><span class="cx"> do_action( 'edit_terms', $alias->term_id, $taxonomy );
</span><span class="cx"> $wpdb->update($wpdb->terms, compact('term_group'), array('term_id' => $alias->term_id) );
</span><span class="cx"> do_action( 'edited_terms', $alias->term_id, $taxonomy );
</span><ins>+ set_taxonomy_last_changed( $taxonomy );
</ins><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -2223,6 +2226,7 @@
</span><span class="cx"> $term_id = apply_filters('term_id_filter', $term_id, $tt_id);
</span><span class="cx">
</span><span class="cx"> clean_term_cache($term_id, $taxonomy);
</span><ins>+ set_taxonomy_last_changed( $taxonomy );
</ins><span class="cx">
</span><span class="cx"> do_action("created_term", $term_id, $tt_id, $taxonomy);
</span><span class="cx"> do_action("created_$taxonomy", $term_id, $tt_id);
</span><span class="lines">@@ -2329,6 +2333,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> wp_cache_delete( $object_id, $taxonomy . '_relationships' );
</span><ins>+ set_taxonomy_last_changed( $taxonomy );
</ins><span class="cx">
</span><span class="cx"> do_action('set_object_terms', $object_id, $terms, $tt_ids, $taxonomy, $append, $old_tt_ids);
</span><span class="cx"> return $tt_ids;
</span><span class="lines">@@ -2407,6 +2412,7 @@
</span><span class="cx"> $deleted = $wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->term_relationships WHERE object_id = %d AND term_taxonomy_id IN ($in_tt_ids)", $object_id ) );
</span><span class="cx"> do_action( 'deleted_term_relationships', $object_id, $tt_ids );
</span><span class="cx"> wp_update_term_count( $tt_ids, $taxonomy );
</span><ins>+ set_taxonomy_last_changed( $taxonomy );
</ins><span class="cx">
</span><span class="cx"> return (bool) $deleted;
</span><span class="cx"> }
</span><span class="lines">@@ -2565,6 +2571,7 @@
</span><span class="cx"> do_action( 'edit_terms', $alias->term_id, $taxonomy );
</span><span class="cx"> $wpdb->update( $wpdb->terms, compact('term_group'), array( 'term_id' => $alias->term_id ) );
</span><span class="cx"> do_action( 'edited_terms', $alias->term_id, $taxonomy );
</span><ins>+ set_taxonomy_last_changed( $taxonomy );
</ins><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -2600,6 +2607,7 @@
</span><span class="cx"> $term_id = apply_filters('term_id_filter', $term_id, $tt_id);
</span><span class="cx">
</span><span class="cx"> clean_term_cache($term_id, $taxonomy);
</span><ins>+ set_taxonomy_last_changed( $taxonomy );
</ins><span class="cx">
</span><span class="cx"> do_action("edited_term", $term_id, $tt_id, $taxonomy);
</span><span class="cx"> do_action("edited_$taxonomy", $term_id, $tt_id);
</span><span class="lines">@@ -2738,9 +2746,12 @@
</span><span class="cx">
</span><span class="cx"> $taxonomies = get_object_taxonomies( $object_type );
</span><span class="cx">
</span><del>- foreach ( $object_ids as $id )
- foreach ( $taxonomies as $taxonomy )
</del><ins>+ foreach ( $object_ids as $id ) {
+ foreach ( $taxonomies as $taxonomy ) {
</ins><span class="cx"> wp_cache_delete($id, "{$taxonomy}_relationships");
</span><ins>+ set_taxonomy_last_changed( $taxonomy );
+ }
+ }
</ins><span class="cx">
</span><span class="cx"> do_action('clean_object_term_cache', $object_ids, $object_type);
</span><span class="cx"> }
</span><span class="lines">@@ -2800,6 +2811,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> do_action('clean_term_cache', $ids, $taxonomy);
</span><ins>+ set_taxonomy_last_changed( $taxonomy );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> wp_cache_set( 'last_changed', microtime(), 'terms' );
</span><span class="lines">@@ -2819,6 +2831,9 @@
</span><span class="cx"> * @return bool|array Empty array if $terms found, but not $taxonomy. False if nothing is in cache for $taxonomy and $id.
</span><span class="cx"> */
</span><span class="cx"> function get_object_term_cache($id, $taxonomy) {
</span><ins>+ if ( ! post_taxonomy_is_fresh( $id, $taxonomy ) ) {
+ return false;
+ }
</ins><span class="cx"> $cache = wp_cache_get($id, "{$taxonomy}_relationships");
</span><span class="cx"> return $cache;
</span><span class="cx"> }
</span><span class="lines">@@ -3117,6 +3132,7 @@
</span><span class="cx"> $wpdb->update( $wpdb->term_taxonomy, compact( 'count' ), array( 'term_taxonomy_id' => $term ) );
</span><span class="cx"> do_action( 'edited_term_taxonomy', $term, $taxonomy );
</span><span class="cx"> }
</span><ins>+ set_taxonomy_last_changed( $taxonomy->name );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -3142,6 +3158,7 @@
</span><span class="cx"> $wpdb->update( $wpdb->term_taxonomy, compact( 'count' ), array( 'term_taxonomy_id' => $term ) );
</span><span class="cx"> do_action( 'edited_term_taxonomy', $term, $taxonomy );
</span><span class="cx"> }
</span><ins>+ set_taxonomy_last_changed( $taxonomy->name );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -3469,3 +3486,53 @@
</span><span class="cx">
</span><span class="cx"> return $parent;
</span><span class="cx"> }
</span><ins>+
+/**
+ * Retrieve the 'last_changed' value for the passed taxonomy. Retrieves
+ * from cache, if present
+ *
+ * @since 3.9.0
+ *
+ * @param string $taxonomy
+ * @return int
+ */
+function get_taxonomy_last_changed( $taxonomy ) {
+ $last_changed = wp_cache_get( 'last_changed', $taxonomy );
+ if ( ! $last_changed ) {
+ $last_changed = microtime();
+ wp_cache_set( 'last_changed', $last_changed, $taxonomy );
+ }
+ return $last_changed;
+}
+
+/**
+ * Reset 'last_changed' for the passed taxonomy
+ *
+ * @since 3.9.0
+ *
+ * @param string $taxonomy
+ * @return int
+ */
+function set_taxonomy_last_changed( $taxonomy ) {
+ wp_cache_delete( 'last_changed', $taxonomy );
+ return get_taxonomy_last_changed( $taxonomy );
+}
+
+/**
+ * Determine if a post's cache for the passed taxonomy
+ * is in sync.
+ * @since 3.9.0
+ *
+ * @param int $id
+ * @param string $taxonomy
+ * @return boolean
+ */
+function post_taxonomy_is_fresh( $id, $taxonomy ) {
+ $last_changed = get_taxonomy_last_changed( $taxonomy );
+ $post_last_changed = wp_cache_get( $id, $taxonomy . '_last_changed' );
+ if ( ! $post_last_changed || $last_changed !== $post_last_changed ) {
+ wp_cache_set( $id, $last_changed, $taxonomy . '_last_changed' );
+ return false;
+ }
+ return true;
+}
</ins><span class="cx">\ No newline at end of file
</span></span></pre></div>
<a id="trunktestsphpunitteststermphp"></a>
<div class="modfile"><h4>Modified: trunk/tests/phpunit/tests/term.php (27100 => 27101)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/phpunit/tests/term.php 2014-02-05 05:16:22 UTC (rev 27100)
+++ trunk/tests/phpunit/tests/term.php 2014-02-06 01:40:05 UTC (rev 27101)
</span><span class="lines">@@ -571,6 +571,56 @@
</span><span class="cx"> /**
</span><span class="cx"> * @ticket 22526
</span><span class="cx"> */
</span><ins>+ function test_get_taxonomy_last_changed() {
+ $last_changed = get_taxonomy_last_changed( 'category' );
+ $last_changed_cache = wp_cache_get( 'last_changed', 'category' );
+ $this->assertEquals( $last_changed, $last_changed_cache );
+ wp_cache_delete( 'last_changed', 'category' );
+ $this->assertEquals( $last_changed, $last_changed_cache );
+ $last_changed = get_taxonomy_last_changed( 'category' );
+ $this->assertNotEquals( $last_changed, $last_changed_cache );
+
+ $last_changed2 = get_taxonomy_last_changed( 'category' );
+ $this->factory->category->create();
+ $last_changed3 = get_taxonomy_last_changed( 'category' );
+ $this->assertNotEquals( $last_changed2, $last_changed3 );
+ }
+
+ /**
+ * @ticket 22526
+ */
+ function test_set_taxonomy_last_changed() {
+ $last_changed1 = set_taxonomy_last_changed( 'category' );
+ $last_changed2 = set_taxonomy_last_changed( 'category' );
+ $this->assertNotEquals( $last_changed1, $last_changed2 );
+
+ $last_changed3 = set_taxonomy_last_changed( 'category' );
+ $last_changed4 = get_taxonomy_last_changed( 'category' );
+ $this->assertEquals( $last_changed3, $last_changed4 );
+ }
+
+ /**
+ * @ticket 22526
+ */
+ function test_post_taxonomy_is_fresh() {
+ $post_id = $this->factory->post->create();
+ $term_id = $this->factory->category->create( array( 'name' => 'Foo' ) );
+ wp_set_post_categories( $post_id, $term_id );
+
+ $this->assertFalse( post_taxonomy_is_fresh( $post_id, 'category' ) );
+ $this->assertTrue( post_taxonomy_is_fresh( $post_id, 'category' ) );
+ $this->assertTrue( post_taxonomy_is_fresh( $post_id, 'category' ) );
+
+ wp_update_term( $term_id, 'category', array( 'name' => 'Bar' ) );
+
+ $this->assertFalse( post_taxonomy_is_fresh( $post_id, 'category' ) );
+ get_the_category( $post_id );
+ $this->assertTrue( post_taxonomy_is_fresh( $post_id, 'category' ) );
+ }
+
+ /**
+ * @ticket 22526
+ */
</ins><span class="cx"> function test_category_name_change() {
</span><span class="cx"> $term = $this->factory->category->create_and_get( array( 'name' => 'Foo' ) );
</span><span class="cx"> $post_id = $this->factory->post->create();
</span></span></pre>
</div>
</div>
</body>
</html>