<!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>[34999] trunk: Return `WP_Post` objects from `wp_get_object_terms()`.</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/34999">34999</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/34999","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-10 03:38:41 +0000 (Sat, 10 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'>Return `WP_Post` objects from `wp_get_object_terms()`.
A side effect of this change is that terms stored in the cache no longer have
an `object_id` associated with them. Previously, `object_id` had always been
cached when the term cache was populated via `wp_get_object_terms()`, a
strategy that was mostly harmless but still incorrect.
See <a href="https://core.trac.wordpress.org/ticket/14162">#14162</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludestaxonomyfunctionsphp">trunk/src/wp-includes/taxonomy-functions.php</a></li>
<li><a href="#trunktestsphpunitteststermwpGetObjectTermsphp">trunk/tests/phpunit/tests/term/wpGetObjectTerms.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<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-10 02:12:40 UTC (rev 34998)
+++ trunk/src/wp-includes/taxonomy-functions.php 2015-10-10 03:38:41 UTC (rev 34999)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2194,7 +2194,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.3.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.2.0 Added support for 'taxonomy', 'parent', and 'term_taxonomy_id' values of `$orderby`.
</span><span class="cx" style="display: block; padding: 0 10px"> * Introduced `$parent` argument.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since 4.4.0 Introduced `$meta_query` and `$update_term_meta_cache` arguments.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.4.0 Introduced `$meta_query` and `$update_term_meta_cache` arguments. When `$fields` is 'all' or
+ * 'all_with_object_id', an array of `WP_Term` objects will be returned.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @global wpdb $wpdb WordPress database abstraction object.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2336,12 +2337,31 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $objects = false;
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'all' == $fields || 'all_with_object_id' == $fields ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $_terms = $wpdb->get_results( $query );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $object_id_index = array();
</ins><span class="cx" style="display: block; padding: 0 10px"> foreach ( $_terms as $key => $term ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $_terms[$key] = sanitize_term( $term, $taxonomy, 'raw' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $term = sanitize_term( $term, $taxonomy, 'raw' );
+ $_terms[ $key ] = $term;
+
+ if ( isset( $term->object_id ) ) {
+ $object_id_index[ $key ] = $term->object_id;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ update_term_cache( $_terms );
+ $_terms = array_map( 'get_term', $_terms );
+
+ // Re-add the object_id data, which is lost when fetching terms from cache.
+ if ( 'all_with_object_id' === $fields ) {
+ foreach ( $_terms as $key => $_term ) {
+ if ( isset( $object_id_index[ $key ] ) ) {
+ $_term->object_id = $object_id_index[ $key ];
+ }
+ }
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $terms = array_merge( $terms, $_terms );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- update_term_cache( $terms );
</del><span class="cx" style="display: block; padding: 0 10px"> $objects = true;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> } elseif ( 'ids' == $fields || 'names' == $fields || 'slugs' == $fields ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $_terms = $wpdb->get_col( $query );
</span><span class="cx" style="display: block; padding: 0 10px"> $_field = ( 'ids' == $fields ) ? 'term_id' : 'name';
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3555,11 +3575,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function update_term_cache( $terms, $taxonomy = '' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( (array) $terms as $term ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $term_taxonomy = $taxonomy;
- if ( empty($term_taxonomy) )
- $term_taxonomy = $term->taxonomy;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Create a copy in case the array was passed by reference.
+ $_term = $term;
</ins><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( $term->term_id, $term, 'terms' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Object ID should not be cached.
+ unset( $_term->object_id );
+
+ wp_cache_add( $term->term_id, $_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></pre></div>
<a id="trunktestsphpunitteststermwpGetObjectTermsphp"></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/wpGetObjectTerms.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/term/wpGetObjectTerms.php 2015-10-10 02:12:40 UTC (rev 34998)
+++ trunk/tests/phpunit/tests/term/wpGetObjectTerms.php 2015-10-10 03:38:41 UTC (rev 34999)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -498,6 +498,131 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEqualSets( array( $terms[0], $terms[1] ), wp_list_pluck( $found, 'term_id' ) );
</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 14162
+ */
+ public function test_should_return_wp_term_objects_for_fields_all() {
+ register_taxonomy( 'wptests_tax', 'post' );
+ $p = $this->factory->post->create();
+ $t = $this->factory->term->create( array( 'taxonomy' => 'wptests_tax' ) );
+ wp_set_object_terms( $p, $t, 'wptests_tax' );
+
+ $found = wp_get_object_terms( $p, 'wptests_tax', array(
+ 'fields' => 'all',
+ ) );
+
+ $this->assertNotEmpty( $found );
+ foreach ( $found as $f ) {
+ $this->assertInstanceOf( 'WP_Term', $f );
+ }
+ }
+
+ /**
+ * @ticket 14162
+ */
+ public function test_should_return_wp_term_objects_for_fields_all_with_object_id() {
+ register_taxonomy( 'wptests_tax', 'post' );
+ $p = $this->factory->post->create();
+ $t = $this->factory->term->create( array( 'taxonomy' => 'wptests_tax' ) );
+ wp_set_object_terms( $p, $t, 'wptests_tax' );
+
+ $found = wp_get_object_terms( $p, 'wptests_tax', array(
+ 'fields' => 'all_with_object_id',
+ ) );
+
+ $this->assertNotEmpty( $found );
+ foreach ( $found as $f ) {
+ $this->assertInstanceOf( 'WP_Term', $f );
+ }
+ }
+
+ /**
+ * @ticket 14162
+ */
+ public function test_should_prime_cache_for_found_terms() {
+ global $wpdb;
+
+ register_taxonomy( 'wptests_tax', 'post' );
+ $p = $this->factory->post->create();
+ $t = $this->factory->term->create( array( 'taxonomy' => 'wptests_tax' ) );
+ wp_set_object_terms( $p, $t, 'wptests_tax' );
+
+ $found = wp_get_object_terms( $p, 'wptests_tax', array(
+ 'fields' => 'all_with_object_id',
+ ) );
+
+ $num_queries = $wpdb->num_queries;
+ $term = get_term( $t );
+ $this->assertSame( $num_queries, $wpdb->num_queries );
+ }
+
+ /**
+ * @ticket 14162
+ */
+ public function test_object_id_should_not_be_cached_with_term_object() {
+ register_taxonomy( 'wptests_tax', 'post' );
+ $p = $this->factory->post->create();
+ $t = $this->factory->term->create( array( 'taxonomy' => 'wptests_tax' ) );
+ wp_set_object_terms( $p, $t, 'wptests_tax' );
+
+ $found = wp_get_object_terms( $p, 'wptests_tax', array(
+ 'fields' => 'all_with_object_id',
+ ) );
+
+ foreach ( $found as $f ) {
+ $this->assertSame( $p, $f->object_id );
+ }
+
+ $term = get_term( $t );
+ $this->assertFalse( isset( $term->object_id ) );
+ }
+
+ /**
+ * @ticket 14162
+ */
+ public function test_term_cache_should_be_primed_for_all_taxonomies() {
+ global $wpdb;
+
+ register_taxonomy( 'wptests_tax1', 'post' );
+ register_taxonomy( 'wptests_tax2', 'post' );
+ $p = $this->factory->post->create();
+ $t1 = $this->factory->term->create( array( 'taxonomy' => 'wptests_tax1' ) );
+ $t2 = $this->factory->term->create( array( 'taxonomy' => 'wptests_tax2' ) );
+ wp_set_object_terms( $p, $t1, 'wptests_tax1' );
+ wp_set_object_terms( $p, $t2, 'wptests_tax2' );
+
+ $found = wp_get_object_terms( $p, array(
+ 'wptests_tax1',
+ 'wptests_tax2',
+ ), array(
+ 'fields' => 'all_with_object_id',
+ ) );
+
+ $this->assertEqualSets( array( $t1, $t2 ), wp_list_pluck( $found, 'term_id' ) );
+
+ $num_queries = $wpdb->num_queries;
+ $term1 = get_term( $t1 );
+ $term2 = get_term( $t2 );
+ $this->assertSame( $num_queries, $wpdb->num_queries );
+ }
+
+ /**
+ * @ticket 14162
+ */
+ public function test_object_id_should_be_set_on_objects_that_share_terms() {
+ register_taxonomy( 'wptests_tax', 'post' );
+ $posts = $this->factory->post->create_many( 2 );
+ $t = $this->factory->term->create( array( 'taxonomy' => 'wptests_tax' ) );
+ wp_set_object_terms( $posts[0], $t, 'wptests_tax' );
+ wp_set_object_terms( $posts[1], $t, 'wptests_tax' );
+
+ $found = wp_get_object_terms( $posts, 'wptests_tax', array(
+ 'fields' => 'all_with_object_id',
+ ) );
+
+ $this->assertEqualSets( $posts, wp_list_pluck( $found, 'object_id' ) );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function filter_get_object_terms( $terms ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $term_ids = wp_list_pluck( $terms, 'term_id' );
</span><span class="cx" style="display: block; padding: 0 10px"> // all terms should still be objects
</span></span></pre>
</div>
</div>
</body>
</html>