<!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>[35032] trunk: Don't cache `WP_Term` objects in `wp_get_object_cache()`.</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/35032">35032</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/35032","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>2015-10-12 15:12:29 +0000 (Mon, 12 Oct 2015)</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'>Don't cache `WP_Term` objects in `wp_get_object_cache()`.
The data stored in the cache should be raw database query results, not
`WP_Term` objects (which may be modified by plugins, and may contain additional
properties that shouldn't be cached).
If term relationships caches were handled in `wp_get_object_terms()` - where
a database query takes place - it would be straightforward to cache raw data.
See <a href="https://core.trac.wordpress.org/ticket/34239">#34239</a>. Since, in fact, `get_the_terms()` caches the value it gets from
`wp_get_object_terms()`, we need a technique that allows us to get raw data
from a `WP_Term` object. Mirroring `WP_User`, we introduce a `data` property
on term objects, which `get_the_terms()` uses to fetch cacheable term info.
Fixes <a href="https://core.trac.wordpress.org/ticket/34262">#34262</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludescategorytemplatephp">trunk/src/wp-includes/category-template.php</a></li>
<li><a href="#trunksrcwpincludesclasswptermphp">trunk/src/wp-includes/class-wp-term.php</a></li>
<li><a href="#trunksrcwpincludestaxonomyfunctionsphp">trunk/src/wp-includes/taxonomy-functions.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="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 2015-10-12 15:12:22 UTC (rev 35031)
+++ trunk/src/wp-includes/category-template.php 2015-10-12 15:12:29 UTC (rev 35032)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1137,9 +1137,15 @@
</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">+ $to_cache = array();
+ foreach ( $terms as $key => $term ) {
+ $to_cache[ $key ] = $term->data;
+ }
+ wp_cache_add( $post->ID, $to_cache, $taxonomy . '_relationships' );
</ins><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">+ $terms = 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"> * Filter 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="trunksrcwpincludesclasswptermphp"></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.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-term.php 2015-10-12 15:12:22 UTC (rev 35031)
+++ trunk/src/wp-includes/class-wp-term.php 2015-10-12 15:12:29 UTC (rev 35032)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -96,6 +96,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public $count = 0;
</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">+ * Info about the term, as stored in the database.
+ *
+ * @since 4.4.0
+ * @access protected
+ * @var array
+ */
+ protected $data = array();
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Stores the term object's sanitization level.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Does not correspond to a database field.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -157,6 +166,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( get_object_vars( $term ) as $key => $value ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->$key = $value;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ $this->data = sanitize_term( $term, $this->taxonomy, $this->filter );
</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">@@ -182,4 +193,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public function to_array() {
</span><span class="cx" style="display: block; padding: 0 10px"> return get_object_vars( $this );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Getter.
+ *
+ * @since 4.4.0
+ * @access public
+ *
+ * @return mixed
+ */
+ public function __get( $key ) {
+ switch ( $key ) {
+ case 'data' :
+ return sanitize_term( $this->{$key}, $this->data->taxonomy, 'raw' );
+ break;
+ }
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunksrcwpincludestaxonomyfunctionsphp"></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-functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/taxonomy-functions.php 2015-10-12 15:12:22 UTC (rev 35031)
+++ trunk/src/wp-includes/taxonomy-functions.php 2015-10-12 15:12:29 UTC (rev 35032)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3062,7 +3062,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $term_id = (int) $term_id;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // First, get all of the original args
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $term = get_term( $term_id, $taxonomy, ARRAY_A );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $term = get_term( $term_id, $taxonomy );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error( $term ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return $term;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3072,8 +3072,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return new WP_Error( 'invalid_term', __( 'Empty Term' ) );
</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">+ $term = (array) $term->data;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Escape data pulled from DB.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $term = wp_slash($term);
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $term = wp_slash( $term );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Merge old and new args with new args overwriting old ones.
</span><span class="cx" style="display: block; padding: 0 10px"> $args = array_merge($term, $args);
</span></span></pre></div>
<a id="trunktestsphpunitteststermphp"></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.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/term.php 2015-10-12 15:12:22 UTC (rev 35031)
+++ trunk/tests/phpunit/tests/term.php 2015-10-12 15:12:29 UTC (rev 35032)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -538,6 +538,44 @@
</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 34262
+ */
+ public function test_get_the_terms_should_not_cache_wp_term_objects() {
+ $p = $this->factory->post->create();
+ register_taxonomy( 'wptests_tax', 'post' );
+ $t = $this->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
+ */
+ public function test_get_the_terms_should_return_wp_term_objects_from_cache() {
+ $p = $this->factory->post->create();
+ register_taxonomy( 'wptests_tax', 'post' );
+ $t = $this->factory->term->create( array( 'taxonomy' => 'wptests_tax' ) );
+ wp_set_object_terms( $p, $t, 'wptests_tax' );
+
+ // Prime the cache.
+ get_the_terms( $p, 'wptests_tax' );
+
+ $cached = get_the_terms( $p, 'wptests_tax' );
+
+ $this->assertNotEmpty( $cached );
+ $this->assertSame( $t, (int) $cached[0]->term_id );
+ $this->assertInstanceOf( 'WP_Term', $cached[0] );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 31086
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_get_the_terms_should_return_zero_indexed_array_when_cache_is_empty() {
</span></span></pre>
</div>
</div>
</body>
</html>