Changeset 37329 for trunk/src/wp-includes/class-wp-widget-factory.php

Timestamp:

04/29/2016 06:48:27 PM (9 years ago)

Author:

westonruter

Message:

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 #35990.
Props mdwheele, PeterRKnight, westonruter.
Fixes #28216.

File:

• trunk/src/wp-includes/class-wp-widget-factory.php (modified) (2 diffs)

trunk/src/wp-includes/class-wp-widget-factory.php

@@ -50 +50 @@
      *
      * @since 2.8.0
+     * @since 4.6.0 The `$widget` param can also be an instance object of `WP_Widget` instead of just a `WP_Widget` subclass name.
      * @access public
      *
-     * @param string $widget_class The name of a WP_Widget subclass.
+     * @param string|WP_Widget $widget Either the name of a `WP_Widget` subclass or an instance of a `WP_Widget` subclass.
      */
-    public function register( $widget_class ) {
-        $this->widgets[$widget_class] = new $widget_class();
+    public function register( $widget ) {
+        if ( $widget instanceof WP_Widget ) {
+            $this->widgets[ spl_object_hash( $widget ) ] = $widget;
+        } else {
+            $this->widgets[ $widget ] = new $widget();
+        }
     }
 
@@ -62 +67 @@
      *
      * @since 2.8.0
+     * @since 4.6.0 The `$widget` param can also be an instance object of `WP_Widget` instead of just a `WP_Widget` subclass name.
      * @access public
      *
-     * @param string $widget_class The name of a WP_Widget subclass.
+     * @param string|WP_Widget $widget Either the name of a `WP_Widget` subclass or an instance of a `WP_Widget` subclass.
      */
-    public function unregister( $widget_class ) {
-        unset( $this->widgets[ $widget_class ] );
+    public function unregister( $widget ) {
+        if ( $widget instanceof WP_Widget ) {
+            unset( $this->widgets[ spl_object_hash( $widget ) ] );
+        } else {
+            unset( $this->widgets[ $widget ] );
+        }
     }