<!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>[34817] trunk/tests/phpunit/tests/widgets.php: Widgets: Add more tests for registering and unregistering sidebars with 1) no ID, 2) a string ID, 3) a numeric ID.</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/34817">34817</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/34817","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>DrewAPicture</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-10-04 05:22:11 +0000 (Sun, 04 Oct 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'>Widgets: Add more tests for registering and unregistering sidebars with 1) no ID, 2) a string ID, 3) a numeric ID.
See <a href="https://core.trac.wordpress.org/ticket/17078">#17078</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestswidgetsphp">trunk/tests/phpunit/tests/widgets.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunktestsphpunittestswidgetsphp"></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/widgets.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/widgets.php 2015-10-04 04:43:46 UTC (rev 34816)
+++ trunk/tests/phpunit/tests/widgets.php 2015-10-04 05:22:11 UTC (rev 34817)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -6,6 +6,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @group widgets
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> class Tests_Widgets extends WP_UnitTestCase {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public $sidebar_index;
+ public $valid_sidebar;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> function clean_up_global_scope() {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_widget_factory, $wp_registered_sidebars, $wp_registered_widgets, $wp_registered_widget_controls, $wp_registered_widget_updates;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -22,6 +24,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function tearDown() {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_customize;
</span><span class="cx" style="display: block; padding: 0 10px"> $wp_customize = null;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> parent::tearDown();
</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">@@ -41,7 +44,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"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @see register_sidebars()
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @group sidebar
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function test_register_sidebars_single() {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -54,7 +57,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"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @see register_sidebars()
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @group sidebar
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function test_register_sidebars_multiple() {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -77,45 +80,116 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @see register_sidebar
- * @see unregister_sidebar
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @group sidebar
</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 test_register_and_unregister_sidebar() {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ function test_register_sidebar_with_no_id() {
+ global $wp_registered_sidebars;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->setExpectedIncorrectUsage( 'register_sidebar' );
+
+ // Incorrectly register a couple of sidebars for fun.
+ register_sidebar();
+ register_sidebar();
+
+ $derived_sidebar_id = "sidebar-2"; // Number of sidebars in the global + 1.
+
+ $this->assertArrayHasKey( $derived_sidebar_id, $wp_registered_sidebars );
+ }
+
+ /**
+ * @group sidebar
+ */
+ function test_unregister_sidebar_registered_with_no_id() {
</ins><span class="cx" style="display: block; padding: 0 10px"> global $wp_registered_sidebars;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->setExpectedIncorrectUsage( 'register_sidebar' );
+
+ // Incorrectly register a couple of sidebars for fun.
+ register_sidebar();
+ register_sidebar();
+
+ $derived_sidebar_id = "sidebar-2"; // Number of sidebars in the global + 1.
+
+ unregister_sidebar( $derived_sidebar_id );
+
+ $this->assertArrayNotHasKey( $derived_sidebar_id, $wp_registered_sidebars );
+ }
+
+ /**
+ * @group sidebar
+ */
+ function test_register_sidebar_with_string_id() {
+
+ global $wp_registered_sidebars;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $sidebar_id = 'wp-unit-test';
</span><span class="cx" style="display: block; padding: 0 10px"> register_sidebar( array( 'id' => $sidebar_id ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( $sidebar_id, $wp_registered_sidebars );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * @group sidebar
+ */
+ function test_unregister_sidebar_with_string_id() {
+ global $wp_registered_sidebars;
+
+ $sidebar_id = 'wp-unit-tests';
+ register_sidebar( array( 'id' => $sidebar_id ) );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> unregister_sidebar( $sidebar_id );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertArrayNotHasKey( 'wp-unit-test', $wp_registered_sidebars );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertArrayNotHasKey( $sidebar_id, $wp_registered_sidebars );
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @group sidebar
+ */
+ function test_register_sidebar_with_numeric_id() {
+ global $wp_registered_sidebars;
+
+ $sidebar_id = 2;
+ register_sidebar( array( 'id' => $sidebar_id ) );
+
+ $this->assertArrayHasKey( $sidebar_id, $wp_registered_sidebars );
+ }
+
+ /**
+ * @group sidebar
+ */
+ function test_unregister_sidebar_with_numeric_id() {
+ global $wp_registered_sidebars;
+
+ $sidebar_id = 2;
+ register_sidebar( array( 'id' => $sidebar_id ) );
+
+ unregister_sidebar( $sidebar_id );
+ $this->assertArrayNotHasKey( $sidebar_id, $wp_registered_sidebars );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Utility hook callback used to store a sidebar ID mid-function.
</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 retrieve_sidebar_id( $index ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ function retrieve_sidebar_id( $index, $valid_sidebar ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->sidebar_index = $index;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->valid_sidebar = $valid_sidebar;
</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 class="cx" style="display: block; padding: 0 10px"> * @group sidebar
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @group drew
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function test_dynamic_sidebar_using_sidebar_registered_with_no_id() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- global $wp_registered_sidebars;
-
</del><span class="cx" style="display: block; padding: 0 10px"> $this->setExpectedIncorrectUsage( 'register_sidebar' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Register a couple of sidebars for fun.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Incorrectly register a couple of sidebars for fun.
</ins><span class="cx" style="display: block; padding: 0 10px"> register_sidebar();
</span><span class="cx" style="display: block; padding: 0 10px"> register_sidebar();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $derived_sidebar_id = "sidebar-3"; // Number of sidebars in the global + 1.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $derived_sidebar_id = "sidebar-2"; // Number of sidebars in the global + 1.
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- add_action( 'dynamic_sidebar_before', array( $this, 'retrieve_sidebar_id' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ add_action( 'dynamic_sidebar_before', array( $this, 'retrieve_sidebar_id' ), 10, 2 );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- dynamic_sidebar( 3 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ dynamic_sidebar( 2 );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $derived_sidebar_id, $this->sidebar_index );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -123,11 +197,29 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * @group sidebar
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ function test_dynamic_sidebar_using_invalid_sidebar_id() {
+ register_sidebar( array( 'id' => 'wp-unit-text' ) );
+
+ add_action( 'dynamic_sidebar_before', array( $this, 'retrieve_sidebar_id' ), 10, 2 );
+
+ // 5 is a fake sidebar ID.
+ dynamic_sidebar( 5 );
+
+ /*
+ * If the sidebar ID is invalid, the second argument passed to
+ * the 'dynamic_sidebar_before' hook will be false.
+ */
+ $this->assertSame( false, $this->valid_sidebar );
+ }
+
+ /**
+ * @group sidebar
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> function test_dynamic_sidebar_numeric_id() {
</span><span class="cx" style="display: block; padding: 0 10px"> $sidebar_id = 2;
</span><span class="cx" style="display: block; padding: 0 10px"> register_sidebar( array( 'id' => $sidebar_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">- add_action( 'dynamic_sidebar_before', array( $this, 'retrieve_sidebar_id' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ add_action( 'dynamic_sidebar_before', array( $this, 'retrieve_sidebar_id' ), 10, 2 );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> dynamic_sidebar( $sidebar_id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -141,7 +233,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $sidebar_id = 'wp-unit-tests';
</span><span class="cx" style="display: block; padding: 0 10px"> register_sidebar( array( 'id' => $sidebar_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">- add_action( 'dynamic_sidebar_before', array( $this, 'retrieve_sidebar_id' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ add_action( 'dynamic_sidebar_before', array( $this, 'retrieve_sidebar_id' ), 10, 2 );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> dynamic_sidebar( $sidebar_id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>