<!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>[49171] trunk: Taxonomy: Fix warnings thrown by custom term count callbacks.</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 { white-space: pre-line; 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/49171">49171</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/49171","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>peterwilsoncc</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-10-16 02:41:15 +0000 (Fri, 16 Oct 2020)</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'>Taxonomy: Fix warnings thrown by custom term count callbacks.
Add a `use` to a closure to avoid an undefined variable throwing a warning. Adds unit tests to ensure the custom callbacks run as expected when defined.
Follow up to <a href="https://core.trac.wordpress.org/changeset/49141">[49141]</a>.
Props ocean90, dd32.
Fixes <a href="https://core.trac.wordpress.org/ticket/40351">#40351</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswptaxonomyphp">trunk/src/wp-includes/class-wp-taxonomy.php</a></li>
<li><a href="#trunktestsphpunitteststaxonomyphp">trunk/tests/phpunit/tests/taxonomy.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswptaxonomyphp"></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-taxonomy.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-taxonomy.php 2020-10-16 01:27:14 UTC (rev 49170)
+++ trunk/src/wp-includes/class-wp-taxonomy.php 2020-10-16 02:41:15 UTC (rev 49171)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -426,7 +426,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> is_callable( $args['update_count_callback'] ) &&
</span><span class="cx" style="display: block; padding: 0 10px"> empty( $args['update_count_by_callback'] )
</span><span class="cx" style="display: block; padding: 0 10px"> ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $args['update_count_by_callback'] = function( $tt_ids, $taxonomy, $modify_by ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $args['update_count_by_callback'] = function( $tt_ids, $taxonomy ) use ( $args ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return call_user_func( $args['update_count_callback'], $tt_ids, $taxonomy );
</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="trunktestsphpunitteststaxonomyphp"></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/taxonomy.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/taxonomy.php 2020-10-16 01:27:14 UTC (rev 49170)
+++ trunk/tests/phpunit/tests/taxonomy.php 2020-10-16 02:41:15 UTC (rev 49171)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4,6 +4,21 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @group taxonomy
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> class Tests_Taxonomy extends WP_UnitTestCase {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Number of times full count callback has been called.
+ *
+ * @var int
+ */
+ public $full_count_cb_called = 0;
+
+ /**
+ * Number of times partial count callback has been called.
+ *
+ * @var int
+ */
+ public $partial_count_cb_called = 0;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> function test_get_post_taxonomies() {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( array( 'category', 'post_tag', 'post_format' ), get_object_taxonomies( 'post' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1030,4 +1045,101 @@
</span><span class="cx" style="display: block; padding: 0 10px"> unregister_taxonomy( $tax );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( get_option( 'default_term_' . $tax ), false );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Ensure custom callbacks are used when registered.
+ *
+ * @covers register_taxonomy
+ * @ticket 40351
+ */
+ function test_register_taxonomy_counting_callbacks() {
+ $post_id = self::factory()->post->create();
+
+ register_taxonomy(
+ 'wp_tax_40351_full_only',
+ 'post',
+ array(
+ 'update_count_callback' => array( $this, 'cb_register_taxonomy_full_count_callback' ),
+ )
+ );
+ $full_term = self::factory()->term->create_and_get(
+ array(
+ 'taxonomy' => 'wp_tax_40351_full_only',
+ )
+ );
+ $full_term_id = $full_term->term_id;
+
+ register_taxonomy(
+ 'wp_tax_40351_partial_only',
+ 'post',
+ array(
+ 'update_count_by_callback' => array( $this, 'cb_register_taxonomy_partial_count_callback' ),
+ )
+ );
+ $partial_term = self::factory()->term->create_and_get(
+ array(
+ 'taxonomy' => 'wp_tax_40351_partial_only',
+ )
+ );
+ $partial_term_id = $partial_term->term_id;
+
+ register_taxonomy(
+ 'wp_tax_40351_both',
+ 'post',
+ array(
+ 'update_count_callback' => array( $this, 'cb_register_taxonomy_full_count_callback' ),
+ 'update_count_by_callback' => array( $this, 'cb_register_taxonomy_partial_count_callback' ),
+ )
+ );
+ $both_term = self::factory()->term->create_and_get(
+ array(
+ 'taxonomy' => 'wp_tax_40351_both',
+ )
+ );
+ $both_term_id = $both_term->term_id;
+ $both_term_ttid = $both_term->term_taxonomy_id;
+
+ wp_set_post_terms( $post_id, $full_term_id, 'wp_tax_40351_full_only' );
+ $this->assertSame( 0, $this->partial_count_cb_called );
+ $this->assertSame( 1, $this->full_count_cb_called );
+
+ wp_set_post_terms( $post_id, $partial_term_id, 'wp_tax_40351_partial_only' );
+ $this->assertSame( 1, $this->partial_count_cb_called );
+ $this->assertSame( 1, $this->full_count_cb_called );
+
+ wp_set_post_terms( $post_id, $both_term_id, 'wp_tax_40351_both' );
+ $this->assertSame( 2, $this->partial_count_cb_called );
+ $this->assertSame( 1, $this->full_count_cb_called );
+
+ // Force a full recount `$both_term` to ensure callback is called.
+ wp_update_term_count( $both_term_ttid, 'wp_tax_40351_both' );
+ $this->assertSame( 2, $this->full_count_cb_called );
+ }
+
+ /**
+ * Custom full count callback for `test_register_taxonomy_counting_callbacks()`.
+ *
+ * For the purpose of this test no database modifications are required, therefore
+ * the parameters passed are unused.
+ *
+ * @param int|array $tt_ids The term_taxonomy_id of the terms.
+ * @param string $taxonomy The context of the term.
+ */
+ function cb_register_taxonomy_full_count_callback( $tt_ids, $taxonomy ) {
+ $this->full_count_cb_called++;
+ }
+
+ /**
+ * Custom partial count callback for `test_register_taxonomy_counting_callbacks()`.
+ *
+ * For the purpose of this test no database modifications are required, therefore
+ * the parameters passed are unused.
+ *
+ * @param int|array $tt_ids The term_taxonomy_id of the terms.
+ * @param string $taxonomy The context of the term.
+ * @param int $modify_by By how many the term count is to be modified.
+ */
+ function cb_register_taxonomy_partial_count_callback( $tt_ids, $taxonomy, $modify_by ) {
+ $this->partial_count_cb_called++;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>