<!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>[41951] trunk: Widgets: Improve extensibility of the Gallery widget and of media widgets generally.</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/41951">41951</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/41951","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>2017-10-19 23:43:22 +0000 (Thu, 19 Oct 2017)</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: 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 <a href="https://core.trac.wordpress.org/ticket/32417">#32417</a>, <a href="https://core.trac.wordpress.org/ticket/41914">#41914</a>.
Fixes <a href="https://core.trac.wordpress.org/ticket/42285">#42285</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminjswidgetsmediagallerywidgetjs">trunk/src/wp-admin/js/widgets/media-gallery-widget.js</a></li>
<li><a href="#trunksrcwpincludeswidgetsclasswpwidgetmediagalleryphp">trunk/src/wp-includes/widgets/class-wp-widget-media-gallery.php</a></li>
<li><a href="#trunksrcwpincludeswidgetsclasswpwidgetmediaphp">trunk/src/wp-includes/widgets/class-wp-widget-media.php</a></li>
<li><a href="#trunktestsphpunittestswidgetsmediawidgetphp">trunk/tests/phpunit/tests/widgets/media-widget.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminjswidgetsmediagallerywidgetjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/js/widgets/media-gallery-widget.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/js/widgets/media-gallery-widget.js 2017-10-19 18:37:10 UTC (rev 41950)
+++ trunk/src/wp-admin/js/widgets/media-gallery-widget.js 2017-10-19 23:43:22 UTC (rev 41951)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -201,7 +201,7 @@
</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"> mediaFrameProps = control.mapModelToMediaFrameProps( control.model.toJSON() );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- selection.gallery = new Backbone.Model( _.pick( mediaFrameProps, 'columns', 'link', 'size', '_orderbyRandom' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ selection.gallery = new Backbone.Model( mediaFrameProps );
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( mediaFrameProps.size ) {
</span><span class="cx" style="display: block; padding: 0 10px"> control.displaySettings.set( 'size', mediaFrameProps.size );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunksrcwpincludeswidgetsclasswpwidgetmediagalleryphp"></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/widgets/class-wp-widget-media-gallery.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/widgets/class-wp-widget-media-gallery.php 2017-10-19 18:37:10 UTC (rev 41950)
+++ trunk/src/wp-includes/widgets/class-wp-widget-media-gallery.php 2017-10-19 23:43:22 UTC (rev 41951)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -46,7 +46,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array Schema for properties.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function get_instance_schema() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $schema = array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'title' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'string',
</span><span class="cx" style="display: block; padding: 0 10px"> 'default' => '',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -87,6 +87,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'should_preview_update' => false,
</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">+
+ /** 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;
</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="lines" style="display: block; padding: 0 10px; color: #888">@@ -100,11 +105,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public function render_media( $instance ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $instance = array_merge( wp_list_pluck( $this->get_instance_schema(), 'default' ), $instance );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $shortcode_atts = array(
- 'ids' => $instance['ids'],
- 'columns' => $instance['columns'],
- 'link' => $instance['link_type'],
- 'size' => $instance['size'],
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $shortcode_atts = array_merge(
+ $instance,
+ array(
+ 'link' => $instance['link_type'],
+ )
</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"> // @codeCoverageIgnoreStart
</span></span></pre></div>
<a id="trunksrcwpincludeswidgetsclasswpwidgetmediaphp"></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/widgets/class-wp-widget-media.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/widgets/class-wp-widget-media.php 2017-10-19 18:37:10 UTC (rev 41950)
+++ trunk/src/wp-includes/widgets/class-wp-widget-media.php 2017-10-19 23:43:22 UTC (rev 41951)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -127,7 +127,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array Schema for properties.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function get_instance_schema() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $schema = array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'attachment_id' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'integer',
</span><span class="cx" style="display: block; padding: 0 10px"> 'default' => 0,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -149,6 +149,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'should_preview_update' => false,
</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">+
+ /**
+ * 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;
</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="trunktestsphpunittestswidgetsmediawidgetphp"></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/media-widget.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/widgets/media-widget.php 2017-10-19 18:37:10 UTC (rev 41950)
+++ trunk/tests/phpunit/tests/widgets/media-widget.php 2017-10-19 23:43:22 UTC (rev 41951)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -165,6 +165,29 @@
</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">+ * 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;
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Test get_instance_schema method.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @covers WP_Widget_Media::get_instance_schema
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -178,6 +201,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'title',
</span><span class="cx" style="display: block; padding: 0 10px"> 'url',
</span><span class="cx" style="display: block; padding: 0 10px"> ), array_keys( $schema ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // 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 );
</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>
</div>
</body>
</html>