<!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>[48433] trunk: Formatting: Prevent wp_slash from returning non-strings as strings.</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 { white-space: pre-line; 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/48433">48433</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/48433","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>whyisjake</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-07-11 00:11:57 +0000 (Sat, 11 Jul 2020)</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'>Formatting: Prevent wp_slash from returning non-strings as strings.
If a bool/float/int is passed into wp_slash it will be coerced into a string.
This changes the behavior to only slash strings. At the same time, handles recursion a little nicer by calling array_map for arrays.
Fixes <a href="https://core.trac.wordpress.org/ticket/42195">#42195</a>, <a href="https://core.trac.wordpress.org/ticket/24106">#24106</a>.
Props johnbillion, andizer, jrf, ryotasakamoto, SergeyBiryukov, donmhico, TobiasBg, markoheijnen, ryan, nacin, devesine, whyisjake.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesformattingphp">trunk/src/wp-includes/formatting.php</a></li>
<li><a href="#trunktestsphpunittestsformattingStripSlashesDeepphp">trunk/tests/phpunit/tests/formatting/StripSlashesDeep.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsformattingWPSlashphp">trunk/tests/phpunit/tests/formatting/WPSlash.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesformattingphp"></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/formatting.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/formatting.php 2020-07-10 23:26:31 UTC (rev 48432)
+++ trunk/src/wp-includes/formatting.php 2020-07-11 00:11:57 UTC (rev 48433)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -5496,12 +5496,13 @@
</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">- * Add slashes to a string or array of strings.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Add slashes to a string or array of strings, in a recursive manner.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * This should be used when preparing data for core API that expects slashed data.
</span><span class="cx" style="display: block; padding: 0 10px"> * This should not be used to escape data going directly into an SQL query.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.6.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.5.0 Leave a non-string value untouched.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|array $value String or array of strings to slash.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string|array Slashed $value
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -5508,17 +5509,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_slash( $value ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_array( $value ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- foreach ( $value as $k => $v ) {
- if ( is_array( $v ) ) {
- $value[ $k ] = wp_slash( $v );
- } else {
- $value[ $k ] = addslashes( $v );
- }
- }
- } else {
- $value = addslashes( $value );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $value = array_map( 'wp_slash', $value );
</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">+ if ( is_string( $value ) ) {
+ return addslashes( $value );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return $value;
</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="trunktestsphpunittestsformattingStripSlashesDeepphp"></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/formatting/StripSlashesDeep.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/formatting/StripSlashesDeep.php 2020-07-10 23:26:31 UTC (rev 48432)
+++ trunk/tests/phpunit/tests/formatting/StripSlashesDeep.php 2020-07-11 00:11:57 UTC (rev 48433)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2,6 +2,7 @@
</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"> * @group formatting
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @group slashes
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> class Tests_Formatting_StripSlashesDeep extends WP_UnitTestCase {
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span></span></pre></div>
<a id="trunktestsphpunittestsformattingWPSlashphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/formatting/WPSlash.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/formatting/WPSlash.php (rev 0)
+++ trunk/tests/phpunit/tests/formatting/WPSlash.php 2020-07-11 00:11:57 UTC (rev 48433)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,103 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * @group formatting
+ */
+class Tests_Formatting_WPSlash extends WP_UnitTestCase {
+
+ /**
+ * @dataProvider data_wp_slash
+ *
+ * @ticket 42195
+ *
+ * @param string $value
+ * @param string $expected
+ */
+ public function test_wp_slash_with( $value, $expected ) {
+ $this->assertSame( $expected, wp_slash( $value ) );
+ }
+
+ /**
+ * Data provider for test_wp_slash().
+ *
+ * @return array {
+ * @type array {
+ * @type mixed $value The value passed to wp_slash().
+ * @type string $expected The expected output of wp_slash().
+ * }
+ * }
+ */
+ public function data_wp_slash() {
+ return array(
+ array( 123, 123 ),
+ array( 123.4, 123.4 ),
+ array( true, true ),
+ array( false, false ),
+ array(
+ array(
+ 'hello',
+ null,
+ '"string"',
+ 125.41,
+ ),
+ array(
+ 'hello',
+ null,
+ '\"string\"',
+ 125.41,
+ ),
+ ),
+ array( "first level 'string'", "first level \'string\'" ),
+ );
+ }
+
+ /**
+ * @ticket 24106
+ */
+ function test_adds_slashes() {
+ $old = "I can't see, isn't that it?";
+ $new = "I can\'t see, isn\'t that it?";
+ $this->assertEquals( $new, wp_slash( $old ) );
+ $this->assertEquals( "I can\\\\\'t see, isn\\\\\'t that it?", wp_slash( $new ) );
+ $this->assertEquals( array( 'a' => $new ), wp_slash( array( 'a' => $old ) ) ); // Keyed array
+ $this->assertEquals( array( $new ), wp_slash( array( $old ) ) ); // Non-keyed
+ }
+
+ /**
+ * @ticket 24106
+ */
+ function test_preserves_original_datatype() {
+
+ $this->assertEquals( true, wp_slash( true ) );
+ $this->assertEquals( false, wp_slash( false ) );
+ $this->assertEquals( 4, wp_slash( 4 ) );
+ $this->assertEquals( 'foo', wp_slash( 'foo' ) );
+ $arr = array(
+ 'a' => true,
+ 'b' => false,
+ 'c' => 4,
+ 'd' => 'foo',
+ );
+ $arr['e'] = $arr; // Add a sub-array
+ $this->assertEquals( $arr, wp_slash( $arr ) ); // Keyed array
+ $this->assertEquals( array_values( $arr ), wp_slash( array_values( $arr ) ) ); // Non-keyed
+
+ $obj = new stdClass;
+ foreach ( $arr as $k => $v ) {
+ $obj->$k = $v;
+ }
+ $this->assertEquals( $obj, wp_slash( $obj ) );
+ }
+
+ /**
+ * @ticket 24106
+ */
+ function test_add_even_more_slashes() {
+ $old = 'single\\slash double\\\\slash triple\\\\\\slash';
+ $new = 'single\\\\slash double\\\\\\\\slash triple\\\\\\\\\\\\slash';
+ $this->assertEquals( $new, wp_slash( $old ) );
+ $this->assertEquals( array( 'a' => $new ), wp_slash( array( 'a' => $old ) ) ); // Keyed array
+ $this->assertEquals( array( $new ), wp_slash( array( $old ) ) ); // Non-keyed
+ }
+
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/tests/formatting/WPSlash.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span></div>
</body>
</html>