<!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>[36243] trunk: Taxonomy: Introduce `unregister_taxonomy()`.</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/36243">36243</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/36243","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>swissspidy</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-01-09 14:57:22 +0000 (Sat, 09 Jan 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'>Taxonomy: Introduce `unregister_taxonomy()`.
This new function can be used to completely unregister non built-in taxonomies.
Fixes <a href="https://core.trac.wordpress.org/ticket/35227">#35227</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludestaxonomyphp">trunk/src/wp-includes/taxonomy.php</a></li>
<li><a href="#trunktestsphpunitincludesutilsphp">trunk/tests/phpunit/includes/utils.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="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 2016-01-09 14:35:03 UTC (rev 36242)
+++ trunk/src/wp-includes/taxonomy.php 2016-01-09 14:57:22 UTC (rev 36243)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -476,6 +476,62 @@
</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">+ * Unregister a taxonomy.
+ *
+ * Can not be used to unregister built-in taxonomies.
+ *
+ * @since 4.5.0
+ *
+ * @global WP $wp Current WordPress environment instance.
+ * @global array $wp_taxonomies List of taxonomies.
+ *
+ * @param string $taxonomy Taxonomy name.
+ * @return bool|WP_Error True on success, WP_Error on failure.
+ */
+function unregister_taxonomy( $taxonomy ) {
+ if ( ! taxonomy_exists( $taxonomy ) ) {
+ return new WP_Error( 'invalid_taxonomy', __( 'Invalid Taxonomy' ) );
+ }
+
+ $taxonomy_args = get_taxonomy( $taxonomy );
+
+ // Do not allow unregistering internal taxonomies.
+ if ( $taxonomy_args->_builtin ) {
+ return new WP_Error( 'invalid_taxonomy', __( 'Unregistering a built-in taxonomy is not allowed' ) );
+ }
+
+ global $wp, $wp_taxonomies;
+
+ // Remove query var.
+ if ( false !== $taxonomy_args->query_var ) {
+ $wp->remove_query_var( $taxonomy_args->query_var );
+ }
+
+ // Remove rewrite tags and permastructs.
+ if ( false !== $taxonomy_args->rewrite ) {
+ remove_rewrite_tag( "%$taxonomy%" );
+ remove_permastruct( $taxonomy );
+ }
+
+ // Unregister callback handling for metabox.
+ remove_filter( 'wp_ajax_add-' . $taxonomy, '_wp_ajax_add_hierarchical_term' );
+
+ // Remove the taxonomy.
+ unset( $wp_taxonomies[ $taxonomy ] );
+
+ /**
+ * Fires after a taxonomy is unregistered.
+ *
+ * @since 4.5.0
+ *
+ * @param string $taxonomy Taxonomy name.
+ */
+ do_action( 'unregistered_taxonomy', $taxonomy );
+
+ return true;
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Builds an object with all taxonomy labels out of a taxonomy object
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Accepted keys of the label array in the taxonomy object:
</span></span></pre></div>
<a id="trunktestsphpunitincludesutilsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/includes/utils.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/includes/utils.php 2016-01-09 14:35:03 UTC (rev 36242)
+++ trunk/tests/phpunit/includes/utils.php 2016-01-09 14:57:22 UTC (rev 36243)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -334,7 +334,7 @@
</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"> function _unregister_taxonomy( $taxonomy_name ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- unset( $GLOBALS['wp_taxonomies'][$taxonomy_name] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ unregister_taxonomy( $taxonomy_name );
</ins><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></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 2016-01-09 14:35:03 UTC (rev 36242)
+++ trunk/tests/phpunit/tests/taxonomy.php 2016-01-09 14:57:22 UTC (rev 36243)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -530,4 +530,106 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $tax = get_taxonomy( 'wptests_tax' );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertFalse( $tax->query_var );
</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 35227
+ */
+ public function test_unregister_taxonomy_unknown_taxonomy() {
+ $this->assertWPError( unregister_taxonomy( 'foo' ) );
+ }
+
+ /**
+ * @ticket 35227
+ */
+ public function test_unregister_taxonomy_twice() {
+ register_taxonomy( 'foo', 'post' );
+ $this->assertTrue( unregister_taxonomy( 'foo' ) );
+ $this->assertWPError( unregister_taxonomy( 'foo' ) );
+ }
+
+ /**
+ * @ticket 35227
+ */
+ public function test_unregister_taxonomy_disallow_builtin_taxonomy() {
+ $this->assertWPError( unregister_taxonomy( 'post_tag' ) );
+ $this->assertWPError( unregister_taxonomy( 'category' ) );
+ }
+
+ /**
+ * @ticket 35227
+ */
+ public function test_unregister_taxonomy_removes_query_vars() {
+ global $wp;
+
+ register_taxonomy( 'foo', 'post', array( 'query_var' => 'bar' ) );
+
+ $this->assertInternalType( 'int', array_search( 'bar', $wp->public_query_vars ) );
+ $this->assertTrue( unregister_taxonomy( 'foo' ) );
+ $this->assertFalse( array_search( 'bar', $wp->public_query_vars ) );
+ }
+
+ /**
+ * @ticket 35227
+ */
+ public function test_unregister_taxonomy_removes_permastruct() {
+ $this->set_permalink_structure( '/%postname%' );
+
+ global $wp_rewrite;
+
+ register_taxonomy( 'foo', 'post', array( 'query_var' => 'bar', 'rewrite' => true ) );
+
+ $this->assertInternalType( 'array', $wp_rewrite->extra_permastructs['foo'] );
+ $this->assertTrue( unregister_taxonomy( 'foo' ) );
+ $this->assertFalse( isset($wp_rewrite->extra_permastructs['foo'] ) );
+ }
+
+ /**
+ * @ticket 35227
+ */
+ public function test_unregister_taxonomy_removes_rewrite_rules() {
+ $this->set_permalink_structure( '/%postname%' );
+
+ global $wp_rewrite;
+
+ register_taxonomy( 'foo', 'post', array( 'query_var' => 'bar' ) );
+
+ $count_before = count( $wp_rewrite->rewritereplace );
+
+ $this->assertContains( '%foo%', $wp_rewrite->rewritecode );
+ $this->assertContains( 'bar=', $wp_rewrite->queryreplace );
+ $this->assertTrue( unregister_taxonomy( 'foo' ) );
+ $this->assertNotContains( '%foo%', $wp_rewrite->rewritecode );
+ $this->assertNotContains( 'bar=', $wp_rewrite->queryreplace );
+ $this->assertSame( --$count_before, count( $wp_rewrite->rewritereplace ) ); // Array was reduced by one value.
+ }
+
+ /**
+ * @ticket 35227
+ */
+ public function test_unregister_taxonomy_removes_taxonomy_from_global() {
+ global $wp_taxonomies;
+
+ register_taxonomy( 'foo', 'post' );
+
+ $this->assertInternalType( 'object', $wp_taxonomies['foo'] );
+ $this->assertInternalType( 'object', get_taxonomy( 'foo' ) );
+
+ $this->assertTrue( unregister_taxonomy( 'foo' ) );
+
+ $this->assertFalse( isset( $wp_taxonomies['foo'] ) );
+ $this->assertFalse( get_taxonomy( 'foo' ) );
+ }
+
+ /**
+ * @ticket 35227
+ */
+ public function test_unregister_taxonomy_removes_meta_box_callback() {
+ global $wp_filter;
+
+ register_taxonomy( 'foo', 'post' );
+
+ $this->assertSame( 1, count( $wp_filter['wp_ajax_add-foo'] ) );
+ $this->assertTrue( unregister_taxonomy( 'foo' ) );
+ $this->assertSame( array(), $wp_filter['wp_ajax_add-foo'] );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>