<!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>[40673] trunk: Widgets: Ensure return value of `widget_text` filter is not dropped but passed into `widget_text_content` filter for rendering.</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/40673">40673</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/40673","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-05-15 22:35:41 +0000 (Mon, 15 May 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: Ensure return value of `widget_text` filter is not dropped but passed into `widget_text_content` filter for rendering.
Amends <a href="https://core.trac.wordpress.org/changeset/40631">[40631]</a>.
Props vijustin, swissspidy, westonruter.
See <a href="https://core.trac.wordpress.org/ticket/35243">#35243</a>.
Fixes <a href="https://core.trac.wordpress.org/ticket/40772">#40772</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludeswidgetsclasswpwidgettextphp">trunk/src/wp-includes/widgets/class-wp-widget-text.php</a></li>
<li><a href="#trunktestsphpunittestswidgetstextwidgetphp">trunk/tests/phpunit/tests/widgets/text-widget.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludeswidgetsclasswpwidgettextphp"></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-text.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-text.php 2017-05-15 20:12:59 UTC (rev 40672)
+++ trunk/src/wp-includes/widgets/class-wp-widget-text.php 2017-05-15 22:35:41 UTC (rev 40673)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -67,7 +67,7 @@
</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', empty( $instance['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">- $widget_text = ! empty( $instance['text'] ) ? $instance['text'] : '';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $text = ! empty( $instance['text'] ) ? $instance['text'] : '';
</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 Text widget.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -75,11 +75,11 @@
</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><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 $widget_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 $this Current Text widget instance.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $text = apply_filters( 'widget_text', $widget_text, $instance, $this );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $text = apply_filters( 'widget_text', $text, $instance, $this );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $instance['filter'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'content' === $instance['filter'] ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -91,11 +91,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.8.0
</span><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 $widget_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 $this Current Text widget instance.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $text = apply_filters( 'widget_text_content', $widget_text, $instance, $this );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $text = apply_filters( 'widget_text_content', $text, $instance, $this );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> } elseif ( $instance['filter'] ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $text = wpautop( $text ); // Back-compat for instances prior to 4.8.
</span></span></pre></div>
<a id="trunktestsphpunittestswidgetstextwidgetphp"></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/text-widget.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/widgets/text-widget.php 2017-05-15 20:12:59 UTC (rev 40672)
+++ trunk/tests/phpunit/tests/widgets/text-widget.php 2017-05-15 22:35:41 UTC (rev 40673)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -74,8 +74,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'filter' => false,
</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">- add_filter( 'widget_text_content', array( $this, 'filter_widget_text_content' ), 10, 3 );
- add_filter( 'widget_text', array( $this, 'filter_widget_text' ), 10, 3 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ add_filter( 'widget_text_content', array( $this, 'filter_widget_text_content' ), 5, 3 );
+ add_filter( 'widget_text', array( $this, 'filter_widget_text' ), 5, 3 );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Test with filter=false.
</span><span class="cx" style="display: block; padding: 0 10px"> ob_start();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -85,6 +85,8 @@
</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->assertEmpty( $this->widget_text_content_args );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertNotEmpty( $this->widget_text_args );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertContains( '[filter:widget_text]', $output );
+ $this->assertNotContains( '[filter:widget_text_content]', $output );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Test with filter=true.
</span><span class="cx" style="display: block; padding: 0 10px"> $instance['filter'] = true;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -98,6 +100,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $instance, $this->widget_text_args[1] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $widget, $this->widget_text_args[2] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEmpty( $this->widget_text_content_args );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertContains( '[filter:widget_text]', $output );
+ $this->assertNotContains( '[filter:widget_text_content]', $output );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Test with filter=content, the upgraded widget.
</span><span class="cx" style="display: block; padding: 0 10px"> $instance['filter'] = 'content';
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -111,9 +115,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $instance, $this->widget_text_args[1] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $widget, $this->widget_text_args[2] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertCount( 3, $this->widget_text_content_args );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEquals( wpautop( $instance['text'] ), $this->widget_text_content_args[0] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEquals( $instance['text'] . '[filter:widget_text]', $this->widget_text_content_args[0] );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $instance, $this->widget_text_content_args[1] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $widget, $this->widget_text_content_args[2] );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertContains( wpautop( $instance['text'] . '[filter:widget_text][filter:widget_text_content]' ), $output );
</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">@@ -127,6 +132,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function filter_widget_text( $widget_text, $instance, $widget ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->widget_text_args = func_get_args();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $widget_text .= '[filter:widget_text]';
</ins><span class="cx" style="display: block; padding: 0 10px"> return $widget_text;
</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">@@ -141,6 +147,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function filter_widget_text_content( $widget_text, $instance, $widget ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->widget_text_content_args = func_get_args();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $widget_text .= '[filter:widget_text_content]';
</ins><span class="cx" style="display: block; padding: 0 10px"> return $widget_text;
</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>