[wp-trac] [WordPress Trac] #41394: Application of widget_text filters passed unexpected $instance data (was: Custom HTML widget applies widget_text filters with unexpected $instance data)

[WordPress Trac]

#41394: Application of widget_text filters passed unexpected $instance data
--------------------------+--------------------------
 Reporter:  westonruter   |       Owner:  westonruter
     Type:  defect (bug)  |      Status:  accepted
 Priority:  normal        |   Milestone:  4.8.1
Component:  Widgets       |     Version:  trunk
 Severity:  normal        |  Resolution:
 Keywords:  has-patch     |     Focuses:
--------------------------+--------------------------

Old description:

> The Custom HTML widget (#40907) applies the `widget_text` filters on its
> content to ensure that when a user moves HTML from a Text widget over to
> a Custom HTML widget, it will get all of the same filters applied. See
> [41086]. There are still `widget_text_content` and
> `widget_custom_html_content` filters that apply to the Text widget and
> Custom HTML widget respectively, but they share this same `widget_text`
> filter that has been around since WP 2.3.0.
>
> When the Custom HTML widget applies the `widget_text` filters, it is
> supplying the Custom HTML widget's `$instance` as the filter's second
> argument. This could cause problems for plugins that filter `widget_text`
> because they may expect a widget's instance data to look like:
>
> {{{#!json
> {
>     "title": "The Title",
>     "text": "Hello World",
>     "filter": false
> }
> }}}
>
> When instead the Custom HTML widget instances look like:
>
> {{{#!json
> {
>     "title": "The Title",
>     "content": "Hello World"
> }
> }}}
>
> So in order to preserve backwards compatibility for plugins that look at
> the `$instance` param, the instance data needs to be transformed from the
> Custom HTML instance schema over to the Text widget instance schema.

New description:

 The Custom HTML widget (#40907) applies the `widget_text` filters on its
 content to ensure that when a user moves HTML from a Text widget over to a
 Custom HTML widget, it will get all of the same filters applied. See
 [41086]. There are still `widget_text_content` and
 `widget_custom_html_content` filters that apply to the Text widget and
 Custom HTML widget respectively, but they share this same `widget_text`
 filter that has been around since WP 2.3.0.

 When the Custom HTML widget applies the `widget_text` filters, it is
 supplying the Custom HTML widget's `$instance` as the filter's second
 argument. This could cause problems for plugins that filter `widget_text`
 because they may expect a widget's instance data to look like:

 {{{#!json
 {
     "title": "The Title",
     "text": "Hello World",
     "filter": false
 }
 }}}

 When instead the Custom HTML widget instances look like:

 {{{#!json
 {
     "title": "The Title",
     "content": "Hello World"
 }
 }}}

 So in order to preserve backwards compatibility for plugins that look at
 the `$instance` param, the instance data needs to be transformed from the
 Custom HTML instance schema over to the Text widget instance schema.

 This is also actually the case for existing `widget_text` filters for the
 Text widget itself. In 4.8 the `filter` param was set to a fixed `content`
 but if any filters do any checking of `$instance['filter'] === true` then
 these checks will fail. Now that there is a boolean `legacy` instance
 property, we can eliminate the `content` value for the `filter` property
 and just always set it to `true`.

--

Comment (by westonruter):

 I'm expanding the scope here to also account for `widget_text` filters
 applying when plugins will expect `$instance['filter']` to be a boolean,
 not a boolean with a possible string value of `content`.

--
Ticket URL: <https://core.trac.wordpress.org/ticket/41394#comment:5>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform