Changeset 41245

Timestamp:

08/13/2017 05:24:14 AM (8 years ago)

Author:

westonruter

Message:

Widgets: Fix extensibility of Text widgets so that JS logic will initialize on subclassed widgets.

Amends [40631].
See #35243.
Fixes #41540.

Location:

trunk

Files:

• src/wp-admin/js/widgets/text-widgets.js (modified) (4 diffs)
• src/wp-includes/widgets/class-wp-widget-text.php (modified) (2 diffs)
• tests/phpunit/tests/widgets/text-widget.php (modified) (2 diffs)

trunk/src/wp-admin/js/widgets/text-widgets.js

@@ -5 +5 @@
 
     var component = {
-        dismissedPointers: []
+        dismissedPointers: [],
+        idBases: [ 'text' ]
     };
 
@@ -358 +359 @@
 
         idBase = widgetForm.find( '> .id_base' ).val();
-        if ( 'text' !== idBase ) {
+        if ( -1 === component.idBases.indexOf( idBase ) ) {
             return;
         }
@@ -425 +426 @@
 
         idBase = widgetForm.find( '> .widget-control-actions > .id_base' ).val();
-        if ( 'text' !== idBase ) {
+        if ( -1 === component.idBases.indexOf( idBase ) ) {
             return;
         }
@@ -462 +463 @@
 
         idBase = widgetForm.find( '> .id_base' ).val();
-        if ( 'text' !== idBase ) {
+        if ( -1 === component.idBases.indexOf( idBase ) ) {
             return;
         }

trunk/src/wp-includes/widgets/class-wp-widget-text.php

@@ -56 +56 @@
         $this->registered = true;
 
+        wp_add_inline_script( 'text-widgets', sprintf( 'wp.textWidgets.idBases.push( %s );', wp_json_encode( $this->id_base ) ) );
+
         // Note that the widgets component in the customizer will also do the 'admin_print_scripts-widgets.php' action in WP_Customize_Widgets::print_scripts().
         add_action( 'admin_print_scripts-widgets.php', array( $this, 'enqueue_admin_scripts' ) );
 
         // Note that the widgets component in the customizer will also do the 'admin_footer-widgets.php' action in WP_Customize_Widgets::print_footer_scripts().
-        add_action( 'admin_footer-widgets.php', array( $this, 'render_control_template_scripts' ) );
+        add_action( 'admin_footer-widgets.php', array( 'WP_Widget_Text', 'render_control_template_scripts' ) );
     }
 
@@ -377 +379 @@
      *
      * @since 4.8.0
-     */
-    public function render_control_template_scripts() {
+     * @since 4.9.0 The method is now static.
+     */
+    public static function render_control_template_scripts() {
         $dismissed_pointers = explode( ',', (string) get_user_meta( get_current_user_id(), 'dismissed_wp_pointers', true ) );
         ?>

trunk/tests/phpunit/tests/widgets/text-widget.php

@@ -65 +65 @@
 
         $this->assertEquals( 10, has_action( 'admin_print_scripts-widgets.php', array( $widget, 'enqueue_admin_scripts' ) ) );
-        $this->assertEquals( 10, has_action( 'admin_footer-widgets.php', array( $widget, 'render_control_template_scripts' ) ) );
+        $this->assertEquals( 10, has_action( 'admin_footer-widgets.php', array( 'WP_Widget_Text', 'render_control_template_scripts' ) ) );
+        $this->assertContains( 'wp.textWidgets.idBases.push( "text" );', wp_scripts()->registered['text-widgets']->extra['after'] );
     }
 
@@ -746 +747 @@
      */
     function test_render_control_template_scripts() {
-        $widget = new WP_Widget_Text();
-
-        ob_start();
-        $widget->render_control_template_scripts();
+        ob_start();
+        WP_Widget_Text::render_control_template_scripts();
         $output = ob_get_clean();