<!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>[31207] trunk: Bail out of hierarchy loops in `_get_term_children()`.</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/31207">31207</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/31207","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-01-16 17:09:11 +0000 (Fri, 16 Jan 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'>Bail out of hierarchy loops in `_get_term_children()`.
This prevents infinite loops that lead to PHP nesting limit fatal errors.
Props boonebgorges, sgrant.
Fixes <a href="https://core.trac.wordpress.org/ticket/24461">#24461</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludestaxonomyphp">trunk/src/wp-includes/taxonomy.php</a></li>
<li><a href="#trunktestsphpunitteststermgetTermsphp">trunk/tests/phpunit/tests/term/getTerms.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludestaxonomyphp"></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.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/taxonomy.php 2015-01-16 16:45:21 UTC (rev 31206)
+++ trunk/src/wp-includes/taxonomy.php 2015-01-16 17:09:11 UTC (rev 31207)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3825,11 +3825,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.3.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $term_id The ancestor term: all returned terms should be descendants of $term_id.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $terms The set of terms---either an array of term objects or term IDs---from which those that are descendants of $term_id will be chosen.
- * @param string $taxonomy The taxonomy which determines the hierarchy of the terms.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $terms The set of terms - either an array of term objects or term IDs - from which those that
+ * are descendants of $term_id will be chosen.
+ * @param string $taxonomy The taxonomy which determines the hierarchy of the terms.
+ * @param array $ancestors Term ancestors that have already been identified. Passed by reference, to keep track of
+ * found terms when recursing the hierarchy. The array of located ancestors is used to prevent
+ * infinite recursion loops.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return array The subset of $terms that are descendants of $term_id.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function _get_term_children($term_id, $terms, $taxonomy) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function _get_term_children( $term_id, $terms, $taxonomy, &$ancestors = array() ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $empty_array = array();
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty($terms) )
</span><span class="cx" style="display: block; padding: 0 10px"> return $empty_array;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3840,6 +3844,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ( 0 != $term_id ) && ! isset($has_children[$term_id]) )
</span><span class="cx" style="display: block; padding: 0 10px"> return $empty_array;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Include the term itself in the ancestors array, so we can properly detect when a loop has occurred.
+ if ( empty( $ancestors ) ) {
+ $ancestors[] = $term_id;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> foreach ( (array) $terms as $term ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $use_id = false;
</span><span class="cx" style="display: block; padding: 0 10px"> if ( !is_object($term) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3849,7 +3858,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $use_id = true;
</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 ( $term->term_id == $term_id ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Don't recurse if we've already identified the term as a child - this indicates a loop.
+ if ( in_array( $term->term_id, $ancestors ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> continue;
</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">@@ -3862,7 +3872,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( !isset($has_children[$term->term_id]) )
</span><span class="cx" style="display: block; padding: 0 10px"> continue;
</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 ( $children = _get_term_children($term->term_id, $terms, $taxonomy) )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $use_id ) {
+ $ancestors = array_merge( $ancestors, $term_list );
+ } else {
+ $ancestors = array_merge( $ancestors, wp_list_pluck( $term_list, 'term_id' ) );
+ }
+
+ if ( $children = _get_term_children( $term->term_id, $terms, $taxonomy, $ancestors) )
</ins><span class="cx" style="display: block; padding: 0 10px"> $term_list = array_merge($term_list, $children);
</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="trunktestsphpunitteststermgetTermsphp"></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/getTerms.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/term/getTerms.php 2015-01-16 16:45:21 UTC (rev 31206)
+++ trunk/tests/phpunit/tests/term/getTerms.php 2015-01-16 17:09:11 UTC (rev 31207)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -394,6 +394,44 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'wp_update_term_parent', 'wp_check_term_hierarchy_for_loops', 10, 3 );
</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">+ /**
+ * @covers ::_get_term_children
+ * @ticket 24461
+ */
+ public function test__get_term_children_handles_cycles() {
+ remove_filter( 'wp_update_term_parent', 'wp_check_term_hierarchy_for_loops', 10 );
+
+ $c1 = $this->factory->category->create();
+ $c2 = $this->factory->category->create( array( 'parent' => $c1 ) );
+ $c3 = $this->factory->category->create( array( 'parent' => $c2 ) );
+ wp_update_term( $c1, 'category', array( 'parent' => $c3 ) );
+
+ add_filter( 'wp_update_term_parent', 'wp_check_term_hierarchy_for_loops', 10, 3 );
+
+ $result = _get_term_children( $c1, array( $c1, $c2, $c3 ), 'category' );
+
+ $this->assertEqualSets( array( $c2, $c3 ), $result );
+ }
+
+ /**
+ * @covers ::_get_term_children
+ * @ticket 24461
+ */
+ public function test__get_term_children_handles_cycles_when_terms_argument_contains_objects() {
+ remove_filter( 'wp_update_term_parent', 'wp_check_term_hierarchy_for_loops', 10 );
+
+ $c1 = $this->factory->category->create_and_get();
+ $c2 = $this->factory->category->create_and_get( array( 'parent' => $c1->term_id ) );
+ $c3 = $this->factory->category->create_and_get( array( 'parent' => $c2->term_id ) );
+ wp_update_term( $c1->term_id, 'category', array( 'parent' => $c3->term_id ) );
+
+ add_filter( 'wp_update_term_parent', 'wp_check_term_hierarchy_for_loops', 10, 3 );
+
+ $result = _get_term_children( $c1->term_id, array( $c1, $c2, $c3 ), 'category' );
+
+ $this->assertEqualSets( array( $c2, $c3 ), $result );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_get_terms_by_slug() {
</span><span class="cx" style="display: block; padding: 0 10px"> $t1 = $this->factory->tag->create( array( 'slug' => 'foo' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $t2 = $this->factory->tag->create( array( 'slug' => 'bar' ) );
</span></span></pre>
</div>
</div>
</body>
</html>