Changeset 51216

Timestamp:

06/23/2021 01:33:20 AM (3 years ago)

Author:

noisysocks

Message:

Widgets: Fix widget preview not working if widget registered via a instance

The register_widget function can be called with a class name or a class
instance. Once called with a class instance, the class instance is converted to
hash as used key in array.

Props spacedmonkey, zieladam.

Location:

trunk/src/wp-includes

Files:

• class-wp-widget-factory.php (modified) (1 diff)
• rest-api/endpoints/class-wp-rest-widget-types-controller.php (modified) (3 diffs)

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

@@ -113 +113 @@
      */
     public function get_widget_object( $id_base ) {
-        foreach ( $this->widgets as $widget_object ) {
+        $key = $this->get_widget_key( $id_base );
+        if ( '' === $key ) {
+            return null;
+        }
+
+        return $this->widgets[ $key ];
+    }
+
+    /**
+     * Returns the registered key for the given widget type.
+     *
+     * @since 5.8.0
+     *
+     * @param string $id_base Widget type ID.
+     * @return string
+     */
+    public function get_widget_key( $id_base ) {
+        foreach ( $this->widgets as $key => $widget_object ) {
             if ( $widget_object->id_base === $id_base ) {
-                return $widget_object;
+                return $key;
             }
         }
 
-        return null;
+        return '';
     }
 }

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-widget-types-controller.php

@@ -472 +472 @@
 
         $serialized_instance = serialize( $instance );
+        $widget_key = $wp_widget_factory->get_widget_key( $id );
 
         $response = array(
@@ -482 +483 @@
             'preview'  => trim(
                 $this->get_widget_preview(
-                    $widget_object,
+                    $widget_key,
                     $instance
                 )
@@ -504 +505 @@
      * instance. Used by encode_form_data() to preview a widget.
 
-     * @param WP_Widget $widget_object Widget object to call widget() on.
+     * @param string    $widget   The widget's PHP class name (see class-wp-widget.php).
      * @param array     $instance Widget instance settings.
      * @return string
      */
-    private function get_widget_preview( $widget_object, $instance ) {
+    private function get_widget_preview( $widget, $instance ) {
         ob_start();
-        the_widget( get_class( $widget_object ), $instance );
+        the_widget( $widget, $instance );
         return ob_get_clean();
     }