<!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>[30141] trunk: Allow resource_type to be specified in `get_ancestors()`.</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/30141">30141</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/30141","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>2014-11-01 02:57:31 +0000 (Sat, 01 Nov 2014)</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 resource_type to be specified in `get_ancestors()`.
Being explicit about resource type (taxonomy vs post_type) allows for the
proper resolution of conflicts when a taxonomy and post_type share a slug.
Props filosofo.
Fixes <a href="https://core.trac.wordpress.org/ticket/15029">#15029</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesajaxactionsphp">trunk/src/wp-admin/includes/ajax-actions.php</a></li>
<li><a href="#trunksrcwpincludestaxonomyphp">trunk/src/wp-includes/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="trunksrcwpadminincludesajaxactionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/ajax-actions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/ajax-actions.php 2014-11-01 02:38:19 UTC (rev 30140)
+++ trunk/src/wp-admin/includes/ajax-actions.php 2014-11-01 02:57:31 UTC (rev 30141)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -788,7 +788,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $level = 0;
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_taxonomy_hierarchical($taxonomy) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $level = count( get_ancestors( $tag->term_id, $taxonomy ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $level = count( get_ancestors( $tag->term_id, $taxonomy, 'taxonomy' ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> ob_start();
</span><span class="cx" style="display: block; padding: 0 10px"> $wp_list_table->single_row( $tag, $level );
</span><span class="cx" style="display: block; padding: 0 10px"> $noparents = ob_get_clean();
</span></span></pre></div>
<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 2014-11-01 02:38:19 UTC (rev 30140)
+++ trunk/src/wp-includes/taxonomy.php 2014-11-01 02:57:31 UTC (rev 30141)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4054,7 +4054,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $t->rewrite['hierarchical'] ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $hierarchical_slugs = array();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $ancestors = get_ancestors($term->term_id, $taxonomy);
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $ancestors = get_ancestors( $term->term_id, $taxonomy, 'taxonomy' );
</ins><span class="cx" style="display: block; padding: 0 10px"> foreach ( (array)$ancestors as $ancestor ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $ancestor_term = get_term($ancestor, $taxonomy);
</span><span class="cx" style="display: block; padding: 0 10px"> $hierarchical_slugs[] = $ancestor_term->slug;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4279,11 +4279,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Get an array of ancestor IDs for a given object.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $object_id The ID of the object
- * @param string $object_type The type of object for which we'll be retrieving ancestors.
- * @return array of ancestors from lowest to highest in the hierarchy.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 3.1.0
+ * @since 4.1.0 Introduced the 'resource_type' parameter.
+ *
+ * @param int $object_id The ID of the object.
+ * @param string $object_type The type of object for which we'll be retrieving ancestors.
+ * Accepts a post type or a taxonomy name.
+ * @param string $resource_type Optional. Type of resource $object_type is. Accepts 'post_type' or 'taxonomy'.
+ * @return array An array of ancestors from lowest to highest in the hierarchy.
</ins><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_ancestors($object_id = 0, $object_type = '') {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function get_ancestors( $object_id = 0, $object_type = '', $resource_type = '' ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $object_id = (int) $object_id;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $ancestors = array();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4291,16 +4296,24 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $object_id ) ) {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /** This filter is documented in wp-includes/taxonomy.php */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return apply_filters( 'get_ancestors', $ancestors, $object_id, $object_type );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return apply_filters( 'get_ancestors', $ancestors, $object_id, $object_type, $resource_type );
</ins><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 ( is_taxonomy_hierarchical( $object_type ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! $resource_type ) {
+ if ( is_taxonomy_hierarchical( $object_type ) ) {
+ $resource_type = 'taxonomy';
+ } else if ( post_type_exists( $object_type ) ) {
+ $resource_type = 'post_type';
+ }
+ }
+
+ if ( 'taxonomy' === $resource_type ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $term = get_term($object_id, $object_type);
</span><span class="cx" style="display: block; padding: 0 10px"> while ( ! is_wp_error($term) && ! empty( $term->parent ) && ! in_array( $term->parent, $ancestors ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $ancestors[] = (int) $term->parent;
</span><span class="cx" style="display: block; padding: 0 10px"> $term = get_term($term->parent, $object_type);
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- } elseif ( post_type_exists( $object_type ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } elseif ( 'post_type' === $resource_type ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $ancestors = get_post_ancestors($object_id);
</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">@@ -4309,9 +4322,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.1.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $ancestors An array of object ancestors.
- * @param int $object_id Object ID.
- * @param string $object_type Type of object.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $ancestors An array of object ancestors.
+ * @param int $object_id Object ID.
+ * @param string $object_type Type of object.
+ * @param string $resource_type Type of resource $object_type is.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'get_ancestors', $ancestors, $object_id, $object_type );
</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 2014-11-01 02:38:19 UTC (rev 30140)
+++ trunk/tests/phpunit/tests/taxonomy.php 2014-11-01 02:57:31 UTC (rev 30141)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -234,4 +234,103 @@
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 0, wp_insert_category( $cat, 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">+
+ public function test_get_ancestors_taxonomy_non_hierarchical() {
+ register_taxonomy( 'wptests_tax', 'post' );
+ $t = $this->factory->term->create( array(
+ 'taxonomy' => 'wptests_tax',
+ ) );
+
+ $this->assertSame( array(), get_ancestors( $t, 'wptests_tax' ) );
+ _unregister_taxonomy( 'wptests_tax' );
+ }
+
+ public function test_get_ancestors_taxonomy() {
+ register_taxonomy( 'wptests_tax', 'post', array(
+ 'hierarchical' => true,
+ ) );
+ $t1 = $this->factory->term->create( array(
+ 'taxonomy' => 'wptests_tax',
+ ) );
+ $t2 = $this->factory->term->create( array(
+ 'taxonomy' => 'wptests_tax',
+ 'parent' => $t1,
+ ) );
+ $t3 = $this->factory->term->create( array(
+ 'taxonomy' => 'wptests_tax',
+ 'parent' => $t2,
+ ) );
+ $t4 = $this->factory->term->create( array(
+ 'taxonomy' => 'wptests_tax',
+ 'parent' => $t1,
+ ) );
+
+ $this->assertEqualSets( array( $t2, $t1 ), get_ancestors( $t3, 'wptests_tax' ) );
+ _unregister_taxonomy( 'wptests_tax' );
+ }
+
+ public function test_get_ancestors_post_type_non_hierarchical() {
+ register_post_type( 'wptests_pt' );
+ $p = $this->factory->post->create( array(
+ 'taxonomy' => 'wptests_pt',
+ ) );
+
+ $this->assertEqualSets( array(), get_ancestors( $p, 'wptests_tax' ) );
+ }
+
+ public function test_get_ancestors_post_type() {
+ register_post_type( 'wptests_pt', array(
+ 'hierarchical' => true,
+ ) );
+ $p1 = $this->factory->post->create( array(
+ 'post_type' => 'wptests_pt',
+ ) );
+ $p2 = $this->factory->post->create( array(
+ 'post_type' => 'wptests_pt',
+ 'post_parent' => $p1,
+ ) );
+ $p3 = $this->factory->post->create( array(
+ 'post_type' => 'wptests_pt',
+ 'post_parent' => $p2,
+ ) );
+ $p4 = $this->factory->post->create( array(
+ 'post_type' => 'wptests_pt',
+ 'post_parent' => $p1,
+ ) );
+
+ $this->assertEqualSets( array( $p2, $p1 ), get_ancestors( $p3, 'wptests_pt' ) );
+ _unregister_post_type( 'wptests_pt' );
+ }
+
+ /**
+ * @ticket 15029
+ */
+ public function test_get_ancestors_taxonomy_post_type_conflict_resource_type_taxonomy() {
+ register_post_type( 'wptests_conflict', array(
+ 'hierarchical' => true,
+ ) );
+ $p1 = $this->factory->post->create( array(
+ 'post_type' => 'wptests_conflict',
+ ) );
+ $p2 = $this->factory->post->create( array(
+ 'post_type' => 'wptests_conflict',
+ 'post_parent' => $p1,
+ ) );
+
+ register_taxonomy( 'wptests_conflict', 'post', array(
+ 'hierarchical' => true,
+ ) );
+ $t1 = $this->factory->term->create( array(
+ 'taxonomy' => 'wptests_conflict',
+ ) );
+ $t2 = $this->factory->term->create( array(
+ 'taxonomy' => 'wptests_conflict',
+ 'parent' => $t1,
+ ) );
+
+ $this->assertEqualSets( array( $p1 ), get_ancestors( $p2, 'wptests_conflict', 'post_type' ) );
+ $this->assertEqualSets( array( $t1 ), get_ancestors( $t2, 'wptests_conflict', 'taxonomy' ) );
+ $this->assertEqualSets( array( $t1 ), get_ancestors( $t2, 'wptests_conflict' ) );
+ _unregister_post_type( 'wptests_pt' );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>