<!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>[41361] trunk: Widgets: Add shortcode support inside Text widgets.</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/41361">41361</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/41361","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-09-10 06:32:34 +0000 (Sun, 10 Sep 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: Add shortcode support inside Text widgets.
* Used now in core to facilitate displaying inserted media. See <a href="https://core.trac.wordpress.org/ticket/40854">#40854</a>.
* The `[embed]` shortcode is not supported because there is no post context for caching oEmbed responses. This depends on <a href="https://core.trac.wordpress.org/ticket/34115">#34115</a>.
* Add `do_shortcode()` to the `widget_text_content` filter in the same way it is added for `the_content` at priority 11, with `shortcode_unautop()` called at priority 10 after `wpautop()`.
* For Text widget in legacy mode, manually apply `do_shortcode()` (and `shortcode_unautop()` if auto-paragraph checked) if the core-added `widget_text_content` filter remains, unless a plugin added `do_shortcode()` to `widget_text` to prevent applying shortcodes twice.
* Ensure that global `$post` is `null` while filters apply in the Text widget so shortcode handlers won't run with unexpected contexts.
Props westonruter, nacin, aaroncampbell.
See <a href="https://core.trac.wordpress.org/ticket/40854">#40854</a>, <a href="https://core.trac.wordpress.org/ticket/34115">#34115</a>.
Fixes <a href="https://core.trac.wordpress.org/ticket/10457">#10457</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesdefaultfiltersphp">trunk/src/wp-includes/default-filters.php</a></li>
<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="trunksrcwpincludesdefaultfiltersphp"></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/default-filters.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/default-filters.php 2017-09-09 20:43:09 UTC (rev 41360)
+++ trunk/src/wp-includes/default-filters.php 2017-09-10 06:32:34 UTC (rev 41361)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -169,6 +169,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'widget_text_content', 'wptexturize' );
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+add_filter( 'widget_text_content', 'shortcode_unautop' );
+add_filter( 'widget_text_content', 'do_shortcode', 11 ); // Runs after wpautop(); note that $post global will be null when shortcodes run.
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><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></pre></div>
<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-09-09 20:43:09 UTC (rev 41360)
+++ trunk/src/wp-includes/widgets/class-wp-widget-text.php 2017-09-10 06:32:34 UTC (rev 41361)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -183,11 +183,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.8.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global WP_Post $post
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param array $args Display arguments including 'before_title', 'after_title',
</span><span class="cx" style="display: block; padding: 0 10px"> * 'before_widget', and 'after_widget'.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $instance Settings for the current Text widget instance.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function widget( $args, $instance ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ global $post;
</ins><span class="cx" style="display: block; padding: 0 10px">
</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="lines" style="display: block; padding: 0 10px; color: #888">@@ -205,18 +208,24 @@
</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">- * Just-in-time temporarily upgrade Visual Text widget shortcode handling
- * (with support added by plugin) from the widget_text filter to
- * widget_text_content:11 to prevent wpautop from corrupting HTML output
- * added by the shortcode.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Suspend legacy plugin-supplied do_shortcode() for 'widget_text' filter for the visual Text widget to prevent
+ * shortcodes being processed twice. Now do_shortcode() is added to the 'widget_text_content' filter in core itself
+ * and it applies after wpautop() to prevent corrupting HTML output added by the shortcode. When do_shortcode() is
+ * added to 'widget_text_content' then do_shortcode() will be manually called when in legacy mode as well.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $widget_text_do_shortcode_priority = has_filter( 'widget_text', 'do_shortcode' );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $should_upgrade_shortcode_handling = ( $is_visual_text_widget && false !== $widget_text_do_shortcode_priority );
- if ( $should_upgrade_shortcode_handling ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $should_suspend_legacy_shortcode_support = ( $is_visual_text_widget && false !== $widget_text_do_shortcode_priority );
+ if ( $should_suspend_legacy_shortcode_support ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> remove_filter( 'widget_text', 'do_shortcode', $widget_text_do_shortcode_priority );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- add_filter( 'widget_text_content', 'do_shortcode', 11 );
</del><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">+ // Nullify the $post global during widget rendering to prevent shortcodes from running with the unexpected context.
+ $suspended_post = null;
+ if ( isset( $post ) ) {
+ $suspended_post = $post;
+ $post = null;
+ }
+
</ins><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="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -244,14 +253,35 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_Widget_Text $this Current Text widget instance.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $text = apply_filters( 'widget_text_content', $text, $instance, $this );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } else {
+ // Now in legacy mode, add paragraphs and line breaks when checkbox is checked.
+ if ( ! empty( $instance['filter'] ) ) {
+ $text = wpautop( $text );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- } elseif ( ! empty( $instance['filter'] ) ) {
- $text = wpautop( $text ); // Back-compat for instances prior to 4.8.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * Manually do shortcodes on the content when the core-added filter is present. It is added by default
+ * in core by adding do_shortcode() to the 'widget_text_content' filter to apply after wpautop().
+ * Since the legacy Text widget runs wpautop() after 'widget_text' filters are applied, the widget in
+ * legacy mode here manually applies do_shortcode() on the content unless the default
+ * core filter for 'widget_text_content' has been removed, or if do_shortcode() has already
+ * been applied via a plugin adding do_shortcode() to 'widget_text' filters.
+ */
+ if ( has_filter( 'widget_text_content', 'do_shortcode' ) && ! $widget_text_do_shortcode_priority ) {
+ if ( ! empty( $instance['filter'] ) ) {
+ $text = shortcode_unautop( $text );
+ }
+ $text = do_shortcode( $text );
+ }
</ins><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">- // Undo temporary upgrade of the plugin-supplied shortcode handling.
- if ( $should_upgrade_shortcode_handling ) {
- remove_filter( 'widget_text_content', 'do_shortcode', 11 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Restore post global.
+ if ( isset( $suspended_post ) ) {
+ $post = $suspended_post;
+ }
+
+ // Undo suspension of legacy plugin-supplied shortcode handling.
+ if ( $should_suspend_legacy_shortcode_support ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'widget_text', 'do_shortcode', $widget_text_do_shortcode_priority );
</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="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-09-09 20:43:09 UTC (rev 41360)
+++ trunk/tests/phpunit/tests/widgets/text-widget.php 2017-09-10 06:32:34 UTC (rev 41361)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -222,23 +222,43 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @var string
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- protected $example_shortcode_content = "<p>One\nTwo\n\nThree</p>\n<script>\ndocument.write('Test1');\n\ndocument.write('Test2');\n</script>";
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ protected $example_shortcode_content = "<p class='sortcodep'>One\nTwo\n\nThree\n\nThis is testing the <code>[example note='This will not get processed since it is part of shortcode output itself.']</code> shortcode.</p>\n<script>\ndocument.write('Test1');\n\ndocument.write('Test2');\n</script>";
</ins><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">+ * The captured global post during shortcode rendering.
+ *
+ * @var WP_Post|null
+ */
+ protected $post_during_shortcode = null;
+
+ /**
+ * Number of times the shortcode was rendered.
+ *
+ * @var int
+ */
+ protected $shortcode_render_count = 0;
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Do example shortcode.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string Shortcode content.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function do_example_shortcode() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->post_during_shortcode = get_post();
+ $this->shortcode_render_count++;
</ins><span class="cx" style="display: block; padding: 0 10px"> return $this->example_shortcode_content;
</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">- * Test widget method when a plugin has added shortcode support.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Test widget method with shortcodes.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @covers WP_Widget_Text::widget
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function test_widget_shortcodes() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ global $post;
+ $post_id = $this->factory()->post->create();
+ $post = get_post( $post_id );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $args = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'before_title' => '<h2>',
</span><span class="cx" style="display: block; padding: 0 10px"> 'after_title' => "</h2>\n",
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -246,47 +266,100 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'after_widget' => "</section>\n",
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> $widget = new WP_Widget_Text();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- add_filter( 'widget_text', 'do_shortcode' );
</del><span class="cx" style="display: block; padding: 0 10px"> add_shortcode( 'example', array( $this, 'do_example_shortcode' ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $base_instance = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'title' => 'Example',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'text' => "This is an example:\n\n[example]",
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'text' => "This is an example:\n\n[example]\n\nHello.",
</ins><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">- // Legacy Text Widget.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Legacy Text Widget without wpautop.
</ins><span class="cx" style="display: block; padding: 0 10px"> $instance = array_merge( $base_instance, array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'filter' => false,
</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->shortcode_render_count = 0;
</ins><span class="cx" style="display: block; padding: 0 10px"> ob_start();
</span><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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEquals( 1, $this->shortcode_render_count );
+ $this->assertNotContains( '[example]', $output, 'Expected shortcode to be processed in legacy widget with plugin adding filter' );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertContains( $this->example_shortcode_content, $output, 'Shortcode was applied without wpautop corrupting it.' );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEquals( 10, has_filter( 'widget_text', 'do_shortcode' ), 'Filter was restored.' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertNotContains( '<p>' . $this->example_shortcode_content . '</p>', $output, 'Expected shortcode_unautop() to have run.' );
+ $this->assertNull( $this->post_during_shortcode );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Visual Text Widget.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Legacy Text Widget with wpautop.
</ins><span class="cx" style="display: block; padding: 0 10px"> $instance = array_merge( $base_instance, array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'filter' => 'content',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'filter' => true,
+ 'visual' => false,
</ins><span class="cx" style="display: block; padding: 0 10px"> ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->shortcode_render_count = 0;
</ins><span class="cx" style="display: block; padding: 0 10px"> ob_start();
</span><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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEquals( 1, $this->shortcode_render_count );
+ $this->assertNotContains( '[example]', $output, 'Expected shortcode to be processed in legacy widget with plugin adding filter' );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertContains( $this->example_shortcode_content, $output, 'Shortcode was applied without wpautop corrupting it.' );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEquals( 10, has_filter( 'widget_text', 'do_shortcode' ), 'Filter was restored.' );
- $this->assertFalse( has_filter( 'widget_text_content', 'do_shortcode' ), 'Filter was removed.' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertNotContains( '<p>' . $this->example_shortcode_content . '</p>', $output, 'Expected shortcode_unautop() to have run.' );
+ $this->assertNull( $this->post_during_shortcode );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Visual Text Widget with properly-used widget_text_content filter.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Legacy text widget with plugin adding shortcode support as well.
+ add_filter( 'widget_text', 'do_shortcode' );
+ $this->shortcode_render_count = 0;
+ ob_start();
+ $widget->widget( $args, $instance );
+ $output = ob_get_clean();
+ $this->assertEquals( 1, $this->shortcode_render_count );
+ $this->assertNotContains( '[example]', $output, 'Expected shortcode to be processed in legacy widget with plugin adding filter' );
+ $this->assertContains( wpautop( $this->example_shortcode_content ), $output, 'Shortcode was applied *with* wpautop() applying to shortcode output since plugin used legacy filter.' );
+ $this->assertNull( $this->post_during_shortcode );
</ins><span class="cx" style="display: block; padding: 0 10px"> remove_filter( 'widget_text', 'do_shortcode' );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- add_filter( 'widget_text_content', 'do_shortcode', 11 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $instance = array_merge( $base_instance, array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'filter' => 'content',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'filter' => true,
+ 'visual' => true,
</ins><span class="cx" style="display: block; padding: 0 10px"> ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Visual Text Widget with only core-added widget_text_content filter for do_shortcode.
+ $this->assertFalse( has_filter( 'widget_text', 'do_shortcode' ) );
+ $this->assertEquals( 11, has_filter( 'widget_text_content', 'do_shortcode' ), 'Expected core to have set do_shortcode as widget_text_content filter.' );
+ $this->shortcode_render_count = 0;
</ins><span class="cx" style="display: block; padding: 0 10px"> ob_start();
</span><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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEquals( 1, $this->shortcode_render_count );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertContains( $this->example_shortcode_content, $output, 'Shortcode was applied without wpautop corrupting it.' );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertFalse( has_filter( 'widget_text', 'do_shortcode' ), 'Filter was not erroneously restored.' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertNotContains( '<p>' . $this->example_shortcode_content . '</p>', $output, 'Expected shortcode_unautop() to have run.' );
+ $this->assertFalse( has_filter( 'widget_text', 'do_shortcode' ), 'The widget_text filter still lacks do_shortcode handler.' );
+ $this->assertEquals( 11, has_filter( 'widget_text_content', 'do_shortcode' ), 'The widget_text_content filter still has do_shortcode handler.' );
+ $this->assertNull( $this->post_during_shortcode );
+
+ // Visual Text Widget with both filters applied added, one from core and another via plugin.
+ add_filter( 'widget_text', 'do_shortcode' );
+ $this->shortcode_render_count = 0;
+ ob_start();
+ $widget->widget( $args, $instance );
+ $output = ob_get_clean();
+ $this->assertEquals( 1, $this->shortcode_render_count );
+ $this->assertContains( $this->example_shortcode_content, $output, 'Shortcode was applied without wpautop corrupting it.' );
+ $this->assertNotContains( '<p>' . $this->example_shortcode_content . '</p>', $output, 'Expected shortcode_unautop() to have run.' );
+ $this->assertEquals( 10, has_filter( 'widget_text', 'do_shortcode' ), 'Expected do_shortcode to be restored to widget_text.' );
+ $this->assertNull( $this->post_during_shortcode );
+ $this->assertNull( $this->post_during_shortcode );
+ remove_filter( 'widget_text', 'do_shortcode' );
+
+ // Visual Text Widget with shortcode handling disabled via plugin removing filter.
+ remove_filter( 'widget_text_content', 'do_shortcode', 11 );
+ remove_filter( 'widget_text', 'do_shortcode' );
+ $this->shortcode_render_count = 0;
+ ob_start();
+ $widget->widget( $args, $instance );
+ $output = ob_get_clean();
+ $this->assertEquals( 0, $this->shortcode_render_count );
+ $this->assertContains( '[example]', $output );
+ $this->assertNotContains( $this->example_shortcode_content, $output );
+ $this->assertFalse( has_filter( 'widget_text', 'do_shortcode' ) );
+ $this->assertFalse( has_filter( 'widget_text_content', 'do_shortcode' ) );
</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>