Changeset 41951

Timestamp:

10/19/2017 11:43:22 PM (7 years ago)

Author:

westonruter

Message:

Widgets: Improve extensibility of the Gallery widget and of media widgets generally.

• Introduce a widget_{$id_base}_instance_schema filter for plugins to add new properties to a media widget's instance schema.
• Pass all of a gallery widget's instance props to the gallery media frame, not just the ones that core supports.

See #32417, #41914.
Fixes #42285.

Location:

trunk

Files:

• src/wp-admin/js/widgets/media-gallery-widget.js (modified) (1 diff)
• src/wp-includes/widgets/class-wp-widget-media-gallery.php (modified) (3 diffs)
• src/wp-includes/widgets/class-wp-widget-media.php (modified) (2 diffs)
• tests/phpunit/tests/widgets/media-widget.php (modified) (2 diffs)

trunk/src/wp-admin/js/widgets/media-gallery-widget.js

@@ -202 +202 @@
 
             mediaFrameProps = control.mapModelToMediaFrameProps( control.model.toJSON() );
-            selection.gallery = new Backbone.Model( _.pick( mediaFrameProps, 'columns', 'link', 'size', '_orderbyRandom' ) );
+            selection.gallery = new Backbone.Model( mediaFrameProps );
             if ( mediaFrameProps.size ) {
                 control.displaySettings.set( 'size', mediaFrameProps.size );

trunk/src/wp-includes/widgets/class-wp-widget-media-gallery.php

@@ -47 +47 @@
      */
     public function get_instance_schema() {
-        return array(
+        $schema = array(
             'title' => array(
                 'type' => 'string',
@@ -88 +88 @@
             ),
         );
+
+        /** This filter is documented in wp-includes/widgets/class-wp-widget-media.php */
+        $schema = apply_filters( "widget_{$this->id_base}_instance_schema", $schema, $this );
+
+        return $schema;
     }
 
@@ -101 +106 @@
         $instance = array_merge( wp_list_pluck( $this->get_instance_schema(), 'default' ), $instance );
 
-        $shortcode_atts = array(
-            'ids'     => $instance['ids'],
-            'columns' => $instance['columns'],
-            'link'    => $instance['link_type'],
-            'size'    => $instance['size'],
+        $shortcode_atts = array_merge(
+            $instance,
+            array(
+                'link' => $instance['link_type'],
+            )
         );
 

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

@@ -128 +128 @@
      */
     public function get_instance_schema() {
-        return array(
+        $schema = array(
             'attachment_id' => array(
                 'type' => 'integer',
@@ -150 +150 @@
             ),
         );
+
+        /**
+         * Filters the media widget instance schema to add additional properties.
+         *
+         * @since 4.9.0
+         *
+         * @param array           $schema Instance schema.
+         * @param WP_Widget_Media $this   Widget object.
+         */
+        $schema = apply_filters( "widget_{$this->id_base}_instance_schema", $schema, $this );
+
+        return $schema;
     }
 

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

@@ -166 +166 @@
 
     /**
+     * Instance schema args.
+     *
+     * @var array
+     */
+    protected $filter_instance_schema_args;
+
+    /**
+     * Filter instance schema.
+     *
+     * @param array           $schema Schema.
+     * @param WP_Widget_Media $widget Widget.
+     *
+     * @return array
+     */
+    public function filter_instance_schema( $schema, $widget ) {
+        $this->filter_instance_schema_args = compact( 'schema', 'widget' );
+        $schema['injected'] = array(
+            'type' => 'boolean',
+        );
+        return $schema;
+    }
+
+    /**
      * Test get_instance_schema method.
      *
@@ -179 +202 @@
             'url',
         ), array_keys( $schema ) );
+
+        // Check filter usage.
+        $this->filter_instance_schema_args = null;
+        add_filter( 'widget_mocked_instance_schema', array( $this, 'filter_instance_schema' ), 10, 2 );
+        $schema = $widget->get_instance_schema();
+        $this->assertInternalType( 'array', $this->filter_instance_schema_args );
+        $this->assertSame( $widget, $this->filter_instance_schema_args['widget'] );
+        $this->assertEqualSets( array( 'attachment_id', 'title', 'url' ), array_keys( $this->filter_instance_schema_args['schema'] ) );
+        $this->assertArrayHasKey( 'injected', $schema );
     }