<!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>[38877] trunk: Shortcodes: Add new `strip_shortcodes_tagnames` filter.</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/38877">38877</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/38877","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>aaroncampbell</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-10-23 14:24:26 +0000 (Sun, 23 Oct 2016)</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'>Shortcodes: Add new `strip_shortcodes_tagnames` filter.
With the new `strip_shortcodes_tagnames` filter you can specify which shortcodes are stripped by `strip_shortcodes()`. The default is all registered shortcodes.
Props DylanAuty, orvils, swissspidy.
Fixes <a href="https://core.trac.wordpress.org/ticket/37767">#37767</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesshortcodesphp">trunk/src/wp-includes/shortcodes.php</a></li>
<li><a href="#trunktestsphpunittestsshortcodephp">trunk/tests/phpunit/tests/shortcode.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesshortcodesphp"></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/shortcodes.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/shortcodes.php 2016-10-23 14:01:53 UTC (rev 38876)
+++ trunk/src/wp-includes/shortcodes.php 2016-10-23 14:24:26 UTC (rev 38877)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -605,8 +605,21 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Find all registered tag names in $content.
</span><span class="cx" style="display: block; padding: 0 10px"> preg_match_all( '@\[([^<>&/\[\]\x00-\x20=]++)@', $content, $matches );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $tagnames = array_intersect( array_keys( $shortcode_tags ), $matches[1] );
</del><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $tags_to_remove = array_keys( $shortcode_tags );
+
+ /**
+ * Filters the list of shortcode tags to remove from the content.
+ *
+ * @since 4.7.0
+ *
+ * @param array $tag_array Array of shortcode tags to remove.
+ * @param string $content Content shortcodes are being removed from.
+ */
+ $tags_to_remove = apply_filters( 'strip_shortcodes_tagnames', $tags_to_remove, $content );
+
+ $tagnames = array_intersect( $tags_to_remove, $matches[1] );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $tagnames ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return $content;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestsshortcodephp"></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/shortcode.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/shortcode.php 2016-10-23 14:01:53 UTC (rev 38876)
+++ trunk/tests/phpunit/tests/shortcode.php 2016-10-23 14:24:26 UTC (rev 38877)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -340,16 +340,46 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $test_string, shortcode_unautop( wpautop( $test_string ) ) );
</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">+ function data_test_strip_shortcodes() {
+ return array(
+ array( 'before', 'before[gallery]' ),
+ array( 'after', '[gallery]after' ),
+ array( 'beforeafter', 'before[gallery]after' ),
+ array( 'before[after', 'before[after' ),
+ array( 'beforeafter', 'beforeafter' ),
+ array( 'beforeafter', 'before[gallery id="123" size="medium"]after' ),
+ array( 'before[unregistered_shortcode]after', 'before[unregistered_shortcode]after' ),
+ array( 'beforeafter', 'before[footag]after' ),
+ array( 'before after', 'before [footag]content[/footag] after' ),
+ array( 'before after', 'before [footag foo="123"]content[/footag] after' ),
+ );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 10326
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @dataProvider data_test_strip_shortcodes
+ *
+ * @param string $expected Expected output.
+ * @param string $content Content to run strip_shortcodes() on.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- function test_strip_shortcodes() {
- $this->assertEquals('before', strip_shortcodes('before[gallery]'));
- $this->assertEquals('after', strip_shortcodes('[gallery]after'));
- $this->assertEquals('beforeafter', strip_shortcodes('before[gallery]after'));
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ function test_strip_shortcodes( $expected, $content ) {
+ $this->assertEquals( $expected, strip_shortcodes( $content ) );
</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">+ /**
+ * @ticket 37767
+ */
+ function test_strip_shortcodes_filter() {
+ add_filter( 'strip_shortcodes_tagnames', array( $this, '_filter_strip_shortcodes_tagnames' ) );
+ $this->assertEquals( 'beforemiddle [footag]after', strip_shortcodes( 'before[gallery]middle [footag]after' ) );
+ remove_filter( 'strip_shortcodes_tagnames', array( $this, '_filter_strip_shortcodes_tagnames' ) );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ function _filter_strip_shortcodes_tagnames() {
+ return array( 'gallery' );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Store passed in shortcode_atts_{$shortcode} args
</span><span class="cx" style="display: block; padding: 0 10px"> function _filter_atts( $out, $pairs, $atts ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->filter_atts_out = $out;
</span></span></pre>
</div>
</div>
</body>
</html>