<!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>[37329] trunk: Widgets: Allow `WP_Widget` subclass instances (objects) to be registered/unregistered in addition to `WP_Widget` subclass names (strings).</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/37329">37329</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/37329","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>westonruter</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-04-29 18:48:27 +0000 (Fri, 29 Apr 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'>Widgets: Allow `WP_Widget` subclass instances (objects) to be registered/unregistered in addition to `WP_Widget` subclass names (strings).

Allows widgets to be registered which rely on dependency injection. Also will allow for new widget types to be created dynamically (e.g. a Recent Posts widget for each registered post type).

See <a href="https://core.trac.wordpress.org/ticket/35990">#35990</a>.
Props mdwheele, PeterRKnight, westonruter.
Fixes <a href="https://core.trac.wordpress.org/ticket/28216">#28216</a>.</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpwidgetfactoryphp">trunk/src/wp-includes/class-wp-widget-factory.php</a></li>
<li><a href="#trunktestsphpunittestswidgetsphp">trunk/tests/phpunit/tests/widgets.php</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpwidgetfactoryphp"></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-widget-factory.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-widget-factory.php 2016-04-29 17:51:54 UTC (rev 37328)
+++ trunk/src/wp-includes/class-wp-widget-factory.php   2016-04-29 18:48:27 UTC (rev 37329)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -49,24 +49,34 @@
</span><span class="cx" style="display: block; padding: 0 10px">         * Registers a widget subclass.
</span><span class="cx" style="display: block; padding: 0 10px">         *
</span><span class="cx" style="display: block; padding: 0 10px">         * @since 2.8.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         * @since 4.6.0 The `$widget` param can also be an instance object of `WP_Widget` instead of just a `WP_Widget` subclass name.
</ins><span class="cx" style="display: block; padding: 0 10px">          * @access public
</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 string $widget_class The name of a WP_Widget subclass.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * @param string|WP_Widget $widget Either the name of a `WP_Widget` subclass or an instance of a `WP_Widget` subclass.
</ins><span class="cx" style="display: block; padding: 0 10px">          */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-        public function register( $widget_class ) {
-               $this->widgets[$widget_class] = new $widget_class();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function register( $widget ) {
+               if ( $widget instanceof WP_Widget ) {
+                       $this->widgets[ spl_object_hash( $widget ) ] = $widget;
+               } else {
+                       $this->widgets[ $widget ] = new $widget();
+               }
</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">         * Un-registers a widget subclass.
</span><span class="cx" style="display: block; padding: 0 10px">         *
</span><span class="cx" style="display: block; padding: 0 10px">         * @since 2.8.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         * @since 4.6.0 The `$widget` param can also be an instance object of `WP_Widget` instead of just a `WP_Widget` subclass name.
</ins><span class="cx" style="display: block; padding: 0 10px">          * @access public
</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 string $widget_class The name of a WP_Widget subclass.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * @param string|WP_Widget $widget Either the name of a `WP_Widget` subclass or an instance of a `WP_Widget` subclass.
</ins><span class="cx" style="display: block; padding: 0 10px">          */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-        public function unregister( $widget_class ) {
-               unset( $this->widgets[ $widget_class ] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function unregister( $widget ) {
+               if ( $widget instanceof WP_Widget ) {
+                       unset( $this->widgets[ spl_object_hash( $widget ) ] );
+               } else {
+                       unset( $this->widgets[ $widget ] );
+               }
</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="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     2016-04-29 17:51:54 UTC (rev 37328)
+++ trunk/tests/phpunit/tests/widgets.php       2016-04-29 18:48:27 UTC (rev 37329)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -44,6 +44,77 @@
</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">+         * Test that registering a widget class and registering a widget instance work together.
+        *
+        * @see register_widget()
+        * @see unregister_widget()
+        * @ticket 28216
+        */
+       function test_register_and_unregister_widget_instance() {
+               global $wp_widget_factory, $wp_registered_widgets;
+               $this->assertEmpty( $wp_widget_factory->widgets );
+               $this->assertEmpty( $wp_registered_widgets );
+
+               update_option( 'widget_search', array(
+                       2 => array( 'title' => '' ),
+                       '_multiwidget' => 1,
+               ) );
+               update_option( 'widget_better_search', array(
+                       3 => array( 'title' => '' ),
+                       '_multiwidget' => 1,
+               ) );
+               update_option( 'widget_best_search', array(
+                       4 => array( 'title' => '' ),
+                       '_multiwidget' => 1,
+               ) );
+
+               register_widget( 'WP_Widget_Search' );
+               $this->assertArrayHasKey( 'WP_Widget_Search', $wp_widget_factory->widgets );
+
+               $widget_better_search = new WP_Widget_Search();
+               $widget_better_search->id_base = 'better_search';
+               $widget_better_search->name = 'Better Search';
+               $widget_better_search->option_name = 'widget_' . $widget_better_search->id_base;
+               $widget_better_search->widget_options['classname'] = 'widget_' . $widget_better_search->id_base;
+               $widget_better_search->control_options['id_base'] = $widget_better_search->id_base;
+               register_widget( $widget_better_search );
+               $this->assertArrayHasKey( spl_object_hash( $widget_better_search ), $wp_widget_factory->widgets );
+
+               $widget_best_search = new WP_Widget_Search();
+               $widget_best_search->id_base = 'best_search';
+               $widget_best_search->name = 'Best Search';
+               $widget_best_search->option_name = 'widget_' . $widget_best_search->id_base;
+               $widget_best_search->widget_options['classname'] = 'widget_' . $widget_best_search->id_base;
+               $widget_best_search->control_options['id_base'] = $widget_best_search->id_base;
+               register_widget( $widget_best_search );
+               $this->assertArrayHasKey( spl_object_hash( $widget_best_search ), $wp_widget_factory->widgets );
+
+               $this->assertCount( 3, $wp_widget_factory->widgets );
+               $this->assertArrayHasKey( 'WP_Widget_Search', $wp_widget_factory->widgets );
+               $this->assertArrayHasKey( spl_object_hash( $widget_better_search ), $wp_widget_factory->widgets );
+               $this->assertArrayHasKey( spl_object_hash( $widget_best_search ), $wp_widget_factory->widgets );
+
+               $wp_widget_factory->_register_widgets();
+
+               $this->assertArrayHasKey( 'search-2', $wp_registered_widgets );
+               $this->assertArrayHasKey( 'better_search-3', $wp_registered_widgets );
+               $this->assertArrayHasKey( 'best_search-4', $wp_registered_widgets );
+               $this->assertInstanceOf( 'WP_Widget_Search', $wp_registered_widgets['search-2']['callback'][0] );
+               $this->assertSame( $widget_better_search, $wp_registered_widgets['better_search-3']['callback'][0] );
+               $this->assertSame( $widget_best_search, $wp_registered_widgets['best_search-4']['callback'][0] );
+
+               $this->assertArrayHasKey( spl_object_hash( $widget_better_search ), $wp_widget_factory->widgets );
+               $this->assertArrayHasKey( spl_object_hash( $widget_best_search ), $wp_widget_factory->widgets );
+               $this->assertArrayHasKey( 'WP_Widget_Search', $wp_widget_factory->widgets );
+               unregister_widget( 'WP_Widget_Search' );
+               unregister_widget( $widget_better_search );
+               unregister_widget( $widget_best_search );
+               $this->assertArrayNotHasKey( spl_object_hash( $widget_better_search ), $wp_widget_factory->widgets );
+               $this->assertArrayNotHasKey( spl_object_hash( $widget_best_search ), $wp_widget_factory->widgets );
+               $this->assertArrayNotHasKey( 'WP_Widget_Search', $wp_widget_factory->widgets );
+       }
+
+       /**
</ins><span class="cx" style="display: block; padding: 0 10px">          * @group sidebar
</span><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></pre>
</div>
</div>

</body>
</html>