<!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>[41087] branches/4.8: Widgets: Replace adding `balanceTags` on `widget_custom_html_content` filter in favor of just applying `widget_text` filters in Custom HTML widget.</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/41087">41087</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/41087","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-07-18 22:18:12 +0000 (Tue, 18 Jul 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: Replace adding `balanceTags` on `widget_custom_html_content` filter in favor of just applying `widget_text` filters in Custom HTML widget.
Ensures that users who copy HTML from the Text widget in legacy mode over to the Custom HTML widget will continue to get all of the same filters applied, including tag balancing and shortcodes, if a plugin added support. Plugins still have the `widget_text_content` and `widget_custom_html_content` filters they can use to target the specific widget types.
Merges <a href="https://core.trac.wordpress.org/changeset/41086">[41086]</a> onto 4.8 branch.
Amends <a href="https://core.trac.wordpress.org/changeset/40893">[40893]</a>.
See <a href="https://core.trac.wordpress.org/ticket/40951">#40951</a>.
Fixes <a href="https://core.trac.wordpress.org/ticket/40907">#40907</a> for 4.8.1.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches48srcwpincludesdefaultfiltersphp">branches/4.8/src/wp-includes/default-filters.php</a></li>
<li><a href="#branches48srcwpincludesdefaultwidgetsphp">branches/4.8/src/wp-includes/default-widgets.php</a></li>
<li><a href="#branches48srcwpincludeswidgetsclasswpwidgettextphp">branches/4.8/src/wp-includes/widgets/class-wp-widget-text.php</a></li>
<li><a href="#branches48testsphpunittestswidgetscustomhtmlwidgetphp">branches/4.8/tests/phpunit/tests/widgets/custom-html-widget.php</a></li>
</ul>
<h3>Property Changed</h3>
<ul>
<li><a href="#branches48">branches/4.8/</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<span class="cx" style="display: block; padding: 0 10px">Index: branches/4.8
</span><span class="cx" style="display: block; padding: 0 10px">===================================================================
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">--- branches/4.8 2017-07-18 22:10:41 UTC (rev 41086)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+++ branches/4.8 2017-07-18 22:18:12 UTC (rev 41087)
</ins><a id="branches48"></a>
<div class="propset"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Property changes: branches/4.8</h4>
<pre class="diff"><span>
</span></pre></div>
<a id="svnmergeinfo"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: svn:mergeinfo</h4></div>
<span class="cx" style="display: block; padding: 0 10px"> /branches/3.1:18031
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/3.3:20543
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/3.4:21757
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-/trunk:18512,40872-40873,40879,40881,40883,40885,40892-40893,40896-40897,40901,40926-40927,40939,40941,40990-40991,40995,41000,41009,41020,41022,41028,41035,41037,41043,41045-41047,41050,41070,41072
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/trunk:18512,40872-40873,40879,40881,40883,40885,40892-40893,40896-40897,40901,40926-40927,40939,40941,40990-40991,40995,41000,41009,41020,41022,41028,41035,41037,41043,41045-41047,41050,41070,41072,41086
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="branches48srcwpincludesdefaultfiltersphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/4.8/src/wp-includes/default-filters.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/4.8/src/wp-includes/default-filters.php 2017-07-18 22:10:41 UTC (rev 41086)
+++ branches/4.8/src/wp-includes/default-filters.php 2017-07-18 22:18:12 UTC (rev 41087)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -170,8 +170,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'widget_text_content', 'convert_smilies', 20 );
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'widget_text_content', 'wpautop' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-add_filter( 'widget_custom_html_content', 'balanceTags' );
-
</del><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'date_i18n', 'wp_maybe_decline_date' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // RSS filters
</span></span></pre></div>
<a id="branches48srcwpincludesdefaultwidgetsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/4.8/src/wp-includes/default-widgets.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/4.8/src/wp-includes/default-widgets.php 2017-07-18 22:10:41 UTC (rev 41086)
+++ branches/4.8/src/wp-includes/default-widgets.php 2017-07-18 22:18:12 UTC (rev 41087)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -119,7 +119,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /** This filter is documented in wp-includes/widgets/class-wp-widget-pages.php */
</span><span class="cx" style="display: block; padding: 0 10px"> $title = apply_filters( 'widget_title', $instance['title'], $instance, $this->id_base );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $content = $instance['content'];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /** This filter is documented in wp-includes/widgets/class-wp-widget-text.php */
+ $content = apply_filters( 'widget_text', $instance['content'], $instance, $this );
</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"> * Filters the content of the Custom HTML widget.
</span></span></pre></div>
<a id="branches48srcwpincludeswidgetsclasswpwidgettextphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/4.8/src/wp-includes/widgets/class-wp-widget-text.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/4.8/src/wp-includes/widgets/class-wp-widget-text.php 2017-07-18 22:10:41 UTC (rev 41086)
+++ branches/4.8/src/wp-includes/widgets/class-wp-widget-text.php 2017-07-18 22:18:12 UTC (rev 41087)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -213,10 +213,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.3.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.4.0 Added the `$this` parameter.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.8.1 The `$this` param may now be a `WP_Widget_Custom_HTML` object in addition to a `WP_Widget_Text` object.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $text The widget content.
- * @param array $instance Array of settings for the current widget.
- * @param WP_Widget_Text $this Current Text widget instance.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $text The widget content.
+ * @param array $instance Array of settings for the current widget.
+ * @param WP_Widget_Text|WP_Widget_Custom_HTML $this Current Text widget instance.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $text = apply_filters( 'widget_text', $text, $instance, $this );
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="branches48testsphpunittestswidgetscustomhtmlwidgetphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/4.8/tests/phpunit/tests/widgets/custom-html-widget.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/4.8/tests/phpunit/tests/widgets/custom-html-widget.php 2017-07-18 22:10:41 UTC (rev 41086)
+++ branches/4.8/tests/phpunit/tests/widgets/custom-html-widget.php 2017-07-18 22:18:12 UTC (rev 41087)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -21,6 +21,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> protected $widget_custom_html_content_args;
</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">+ * Args passed to the widget_text filter.
+ *
+ * @var array
+ */
+ protected $widget_text_args;
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Test constructor.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @covers WP_Widget_Custom_HTML::__constructor
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -52,22 +59,26 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'content' => $content,
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEquals( 10, has_filter( 'widget_custom_html_content', 'balanceTags' ) );
-
</del><span class="cx" style="display: block; padding: 0 10px"> update_option( 'use_balanceTags', 0 );
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'widget_custom_html_content', array( $this, 'filter_widget_custom_html_content' ), 5, 3 );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ add_filter( 'widget_text', array( $this, 'filter_widget_text' ), 10, 3 );
</ins><span class="cx" style="display: block; padding: 0 10px"> ob_start();
</span><span class="cx" style="display: block; padding: 0 10px"> $this->widget_custom_html_content_args = null;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->widget_text_args = null;
</ins><span class="cx" style="display: block; padding: 0 10px"> $widget->widget( $args, $instance );
</span><span class="cx" style="display: block; padding: 0 10px"> $output = ob_get_clean();
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertNotEmpty( $this->widget_custom_html_content_args );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertContains( '[filter:widget_custom_html_content]', $output );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertNotEmpty( $this->widget_text_args );
+ $this->assertContains( '[filter:widget_text][filter:widget_custom_html_content]', $output );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertNotContains( '<p>', $output );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertNotContains( '<br>', $output );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertNotContains( '</u>', $output );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEquals( $instance, $this->widget_text_args[1] );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $instance, $this->widget_custom_html_content_args[1] );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertSame( $widget, $this->widget_text_args[2] );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $widget, $this->widget_custom_html_content_args[2] );
</span><span class="cx" style="display: block; padding: 0 10px"> remove_filter( 'widget_custom_html_content', array( $this, 'filter_widget_custom_html_content' ), 5, 3 );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ remove_filter( 'widget_text', array( $this, 'filter_widget_text' ), 10 );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> update_option( 'use_balanceTags', 1 );
</span><span class="cx" style="display: block; padding: 0 10px"> ob_start();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -77,16 +88,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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Filters the content of the Custom HTML widget.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filters the content of the Custom HTML widget using the legacy widget_text filter.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $text The widget content.
+ * @param array $instance Array of settings for the current widget.
+ * @param WP_Widget_Custom_HTML $widget Current widget instance.
+ * @return string Widget content.
+ */
+ function filter_widget_text( $text, $instance, $widget ) {
+ $this->widget_text_args = array( $text, $instance, $widget );
+ $text .= '[filter:widget_text]';
+ return $text;
+ }
+
+ /**
+ * Filters the content of the Custom HTML widget using the dedicated widget_custom_html_content filter.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $widget_content The widget content.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $instance Array of settings for the current widget.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_Widget_Custom_HTML $widget Current Custom HTML widget instance.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string Widget content.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function filter_widget_custom_html_content( $widget_content, $instance, $widget ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->widget_custom_html_content_args = func_get_args();
-
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->widget_custom_html_content_args = array( $widget_content, $instance, $widget );
</ins><span class="cx" style="display: block; padding: 0 10px"> $widget_content .= '[filter:widget_custom_html_content]';
</span><span class="cx" style="display: block; padding: 0 10px"> return $widget_content;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>