<!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>[38974] trunk: REST API: Use `wp_get_object_terms()` when fetching terms for a post object.</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/38974">38974</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/38974","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-10-27 01:41:08 +0000 (Thu, 27 Oct 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'>REST API: Use `wp_get_object_terms()` when fetching terms for a post object.
The WP-API plugin originally used a custom method for fetching object
terms in a way that supported the object cache and also accepted all
parameters for `get_terms()`. In <a href="https://core.trac.wordpress.org/changeset/38667">[38667]</a>, the internals of
`wp_get_object_terms()` were modified to use `WP_Term_Query`, thus
delivering in a native fashion the features that the API had
previously achieved bespokely.
Fixes <a href="https://core.trac.wordpress.org/ticket/38504">#38504</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswpresttermscontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php</a></li>
<li><a href="#trunktestsphpunittestsrestapiresttagscontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-tags-controller.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesrestapiendpointsclasswpresttermscontrollerphp"></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/rest-api/endpoints/class-wp-rest-terms-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php 2016-10-27 00:30:11 UTC (rev 38973)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php 2016-10-27 01:41:08 UTC (rev 38974)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -189,20 +189,23 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $prepared_args = apply_filters( "rest_{$this->taxonomy}_query", $prepared_args, $request );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $prepared_args['post'] ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $query_result = $this->get_terms_for_post( $prepared_args );
- $total_terms = $this->total_terms;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $query_result = wp_get_object_terms( $prepared_args['post'], $this->taxonomy, $prepared_args );
+
+ // Used when calling wp_count_terms() below.
+ $prepared_args['object_ids'] = $prepared_args['post'];
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $query_result = get_terms( $this->taxonomy, $prepared_args );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $count_args = $prepared_args;
- unset( $count_args['number'], $count_args['offset'] );
- $total_terms = wp_count_terms( $this->taxonomy, $count_args );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $count_args = $prepared_args;
+ unset( $count_args['number'], $count_args['offset'] );
+ $total_terms = wp_count_terms( $this->taxonomy, $count_args );
</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_count_terms can return a falsy value when the term has no children
- if ( ! $total_terms ) {
- $total_terms = 0;
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // wp_count_terms can return a falsy value when the term has no children
+ if ( ! $total_terms ) {
+ $total_terms = 0;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $response = array();
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $query_result as $term ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $data = $this->prepare_item_for_response( $term, $request );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -238,77 +241,6 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Gets the terms attached to a post.
- *
- * This is an alternative to get_terms() that uses get_the_terms()
- * instead, which hits the object cache. There are a few things not
- * supported, notably `include`, `exclude`. In `self::get_items()` these
- * are instead treated as a full query.
- *
- * @param array $prepared_args Arguments for get_terms().
- * @return array List of term objects. (Total count in `$this->total_terms`)
- */
- protected function get_terms_for_post( $prepared_args ) {
- $query_result = get_the_terms( $prepared_args['post'], $this->taxonomy );
- if ( empty( $query_result ) ) {
- $this->total_terms = 0;
- return array();
- }
-
- /*
- * get_items() verifies that we don't have `include` set, and default
- * ordering is by `name`.
- */
- if ( ! in_array( $prepared_args['orderby'], array( 'name', 'none', 'include' ), true ) ) {
- switch ( $prepared_args['orderby'] ) {
- case 'id':
- $this->sort_column = 'term_id';
- break;
-
- case 'slug':
- case 'term_group':
- case 'description':
- case 'count':
- $this->sort_column = $prepared_args['orderby'];
- break;
- }
- usort( $query_result, array( $this, 'compare_terms' ) );
- }
- if ( strtolower( $prepared_args['order'] ) !== 'asc' ) {
- $query_result = array_reverse( $query_result );
- }
-
- // Pagination.
- $this->total_terms = count( $query_result );
- $query_result = array_slice( $query_result, $prepared_args['offset'], $prepared_args['number'] );
-
- return $query_result;
- }
-
- /**
- * Comparison function for sorting terms by a column.
- *
- * Uses `$this->sort_column` to determine field to sort by.
- *
- * @access protected
- *
- * @param stdClass $left Term object.
- * @param stdClass $right Term object.
- * @return int <0 if left is higher "priority" than right, 0 if equal, >0 if right is higher "priority" than left.
- */
- protected function compare_terms( $left, $right ) {
- $col = $this->sort_column;
- $left_val = $left->$col;
- $right_val = $right->$col;
-
- if ( is_int( $left_val ) && is_int( $right_val ) ) {
- return $left_val - $right_val;
- }
-
- return strcmp( $left_val, $right_val );
- }
-
- /**
</del><span class="cx" style="display: block; padding: 0 10px"> * Checks if a request has access to read the specified term.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_REST_Request $request Full details about the request.
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapiresttagscontrollerphp"></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/rest-api/rest-tags-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/rest-tags-controller.php 2016-10-27 00:30:11 UTC (rev 38973)
+++ trunk/tests/phpunit/tests/rest-api/rest-tags-controller.php 2016-10-27 01:41:08 UTC (rev 38974)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -770,6 +770,34 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $wp_rest_additional_fields = array();
</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 38504
+ */
+ public function test_object_term_queries_are_cached() {
+ global $wpdb;
+
+ $tags = $this->factory->tag->create_many( 2 );
+ $p = $this->factory->post->create();
+ wp_set_object_terms( $p, $tags[0], 'post_tag' );
+
+ $request = new WP_REST_Request( 'GET', '/wp/v2/tags' );
+ $request->set_param( 'post', $p );
+ $response = $this->server->dispatch( $request );
+ $found_1 = wp_list_pluck( $response->data, 'id' );
+
+ unset( $request, $response );
+
+ $num_queries = $wpdb->num_queries;
+
+ $request = new WP_REST_Request( 'GET', '/wp/v2/tags' );
+ $request->set_param( 'post', $p );
+ $response = $this->server->dispatch( $request );
+ $found_2 = wp_list_pluck( $response->data, 'id' );
+
+ $this->assertEqualSets( $found_1, $found_2 );
+ $this->assertSame( $num_queries, $wpdb->num_queries );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function additional_field_get_callback( $object, $request ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return 123;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>