<!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>[37589] trunk: Allow term meta lazy-loading to be selectively disabled in `WP_Query`.</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/37589">37589</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/37589","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-28 03:09:09 +0000 (Sat, 28 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'>Allow term meta lazy-loading to be selectively disabled in `WP_Query`.
The process of lazy-loading can be resource intensive for object that have
terms in large numbers of taxonomies and are running a persistent object cache.
This new parameter allows the feature to be disabled in these cases.
Props DBrumbaugh10Up.
See <a href="https://core.trac.wordpress.org/ticket/36953">#36953</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesqueryphp">trunk/src/wp-includes/query.php</a></li>
<li><a href="#trunktestsphpunitteststermmetaphp">trunk/tests/phpunit/tests/term/meta.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesqueryphp"></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/query.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/query.php 2016-05-27 19:19:12 UTC (rev 37588)
+++ trunk/src/wp-includes/query.php 2016-05-28 03:09:09 UTC (rev 37589)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1468,7 +1468,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.5.0 Removed the `$comments_popup` parameter.
</span><span class="cx" style="display: block; padding: 0 10px"> * Introduced the `$comment_status` and `$ping_status` parameters.
</span><span class="cx" style="display: block; padding: 0 10px"> * Introduced `RAND(x)` syntax for `$orderby`, which allows an integer seed value to random sorts.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since 4.6.0 Added 'post_name__in' support for `$orderby`.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.6.0 Added 'post_name__in' support for `$orderby`. Introduced `$lazy_load_term_meta`.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @access public
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|array $query {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1567,6 +1567,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $title Post title.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type bool $update_post_meta_cache Whether to update the post meta cache. Default true.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type bool $update_post_term_cache Whether to update the post term cache. Default true.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type bool $lazy_load_term_meta Whether to lazy-load term meta. Setting to false will
+ * disable cache priming for term meta, so that each
+ * get_term_meta() call will hit the database.
+ * Defaults to the value of `$update_post_term_cache`.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @type int $w The week number of the year. Default empty. Accepts numbers 0-53.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type int $year The four-digit year. Default empty. Accepts any four-digit year.
</span><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2545,6 +2549,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( !isset($q['update_post_term_cache']) )
</span><span class="cx" style="display: block; padding: 0 10px"> $q['update_post_term_cache'] = true;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! isset( $q['lazy_load_term_meta'] ) ) {
+ $q['lazy_load_term_meta'] = $q['update_post_term_cache'];
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( !isset($q['update_post_meta_cache']) )
</span><span class="cx" style="display: block; padding: 0 10px"> $q['update_post_meta_cache'] = true;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3782,7 +3790,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->posts = array();
</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 ( $q['update_post_term_cache'] ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $q['lazy_load_term_meta'] ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> wp_queue_posts_for_term_meta_lazyload( $this->posts );
</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="trunktestsphpunitteststermmetaphp"></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/meta.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/term/meta.php 2016-05-27 19:19:12 UTC (rev 37588)
+++ trunk/tests/phpunit/tests/term/meta.php 2016-05-28 03:09:09 UTC (rev 37589)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -150,6 +150,61 @@
</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 36593
+ */
+ public function test_lazy_load_term_meta_should_fall_back_on_update_post_term_cache() {
+ $q = new WP_Query( array(
+ 'update_post_term_cache' => true,
+ ) );
+
+ $this->assertTrue( $q->get( 'lazy_load_term_meta' ) );
+
+ $q = new WP_Query( array(
+ 'update_post_term_cache' => false,
+ ) );
+
+ $this->assertFalse( $q->get( 'lazy_load_term_meta' ) );
+ }
+
+ /**
+ * @ticket 36593
+ */
+ public function test_lazy_load_term_meta_false() {
+ global $wpdb;
+
+ $p = self::factory()->post->create( array( 'post_status' => 'publish' ) );
+
+ register_taxonomy( 'wptests_tax', 'post' );
+ $terms = self::factory()->term->create_many( 3, array( 'taxonomy' => 'wptests_tax' ) );
+ wp_set_object_terms( $p, $terms, 'wptests_tax' );
+ foreach ( $terms as $t ) {
+ add_term_meta( $t, 'foo', 'bar' );
+ }
+
+ $q = new WP_Query( array(
+ 'cache_results' => true,
+ 'update_post_term_cache' => true,
+ 'lazy_load_term_meta' => false,
+ ) );
+
+ if ( $q->have_posts() ) {
+ while ( $q->have_posts() ) {
+ $q->the_post();
+
+ // Requests will hit the database.
+ $num_queries = $wpdb->num_queries;
+ $this->assertSame( 'bar', get_term_meta( $terms[0], 'foo', true ) );
+ $num_queries++;
+ $this->assertSame( $num_queries, $wpdb->num_queries );
+
+ $this->assertSame( 'bar', get_term_meta( $terms[1], 'foo', true ) );
+ $num_queries++;
+ $this->assertSame( $num_queries, $wpdb->num_queries );
+ }
+ }
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_adding_term_meta_should_bust_get_terms_cache() {
</span><span class="cx" style="display: block; padding: 0 10px"> $terms = self::factory()->term->create_many( 2, array( 'taxonomy' => 'wptests_tax' ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>