<!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>[24718] trunk/wp-includes: Deprecate wpdb::escape() in favor of wpdb::prepare() and esc_sql().</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">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/24718">24718</a></dd>
<dt>Author</dt> <dd>nacin</dd>
<dt>Date</dt> <dd>2013-07-16 17:44:42 +0000 (Tue, 16 Jul 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Deprecate wpdb::escape() in favor of wpdb::prepare() and esc_sql(). fixes <a href="http://core.trac.wordpress.org/ticket/24774">#24774</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkwpincludesformattingphp">trunk/wp-includes/formatting.php</a></li>
<li><a href="#trunkwpincludeswpdbphp">trunk/wp-includes/wp-db.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwpincludesformattingphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/formatting.php (24717 => 24718)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/formatting.php 2013-07-16 14:58:52 UTC (rev 24717)
+++ trunk/wp-includes/formatting.php 2013-07-16 17:44:42 UTC (rev 24718)
</span><span class="lines">@@ -2591,17 +2591,19 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Escapes data for use in a MySQL query
</del><ins>+ * Escapes data for use in a MySQL query.
</ins><span class="cx"> *
</span><del>- * This is just a handy shortcut for $wpdb->escape(), for completeness' sake
</del><ins>+ * Usually you should prepare queries using wpdb::prepare().
+ * Sometimes, spot-escaping is required or useful. One example
+ * is preparing an array for use in an IN clause.
</ins><span class="cx"> *
</span><span class="cx"> * @since 2.8.0
</span><del>- * @param string $sql Unescaped SQL data
- * @return string The cleaned $sql
</del><ins>+ * @param string $data Unescaped data
+ * @return string Escaped data
</ins><span class="cx"> */
</span><del>-function esc_sql( $sql ) {
</del><ins>+function esc_sql( $data ) {
</ins><span class="cx"> global $wpdb;
</span><del>- return $wpdb->escape( $sql );
</del><ins>+ return $wpdb->_escape( $data );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span></span></pre></div>
<a id="trunkwpincludeswpdbphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/wp-db.php (24717 => 24718)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/wp-db.php 2013-07-16 14:58:52 UTC (rev 24717)
+++ trunk/wp-includes/wp-db.php 2013-07-16 17:44:42 UTC (rev 24718)
</span><span class="lines">@@ -846,16 +846,22 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Weak escape, using addslashes()
</del><ins>+ * Do not use, deprecated.
</ins><span class="cx"> *
</span><del>- * @see addslashes()
</del><ins>+ * Use esc_sql() or wpdb::prepare() instead.
+ *
</ins><span class="cx"> * @since 2.8.0
</span><ins>+ * @deprecated 3.6.0
+ * @see wpdb::prepare
+ * @see esc_sql()
</ins><span class="cx"> * @access private
</span><span class="cx"> *
</span><span class="cx"> * @param string $string
</span><span class="cx"> * @return string
</span><span class="cx"> */
</span><span class="cx"> function _weak_escape( $string ) {
</span><ins>+ if ( func_num_args() === 1 )
+ _deprecated_function( __METHOD__, '3.6', 'wpdb::prepare() or esc_sql()' );
</ins><span class="cx"> return addslashes( $string );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -876,7 +882,6 @@
</span><span class="cx"> /**
</span><span class="cx"> * Escape data. Works on arrays.
</span><span class="cx"> *
</span><del>- * @uses wpdb::_escape()
</del><span class="cx"> * @uses wpdb::_real_escape()
</span><span class="cx"> * @since 2.8.0
</span><span class="cx"> * @access private
</span><span class="lines">@@ -886,7 +891,7 @@
</span><span class="cx"> */
</span><span class="cx"> function _escape( $data ) {
</span><span class="cx"> if ( is_array( $data ) ) {
</span><del>- foreach ( (array) $data as $k => $v ) {
</del><ins>+ foreach ( $data as $k => $v ) {
</ins><span class="cx"> if ( is_array($v) )
</span><span class="cx"> $data[$k] = $this->_escape( $v );
</span><span class="cx"> else
</span><span class="lines">@@ -900,24 +905,30 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Escapes content for insertion into the database using addslashes(), for security.
</del><ins>+ * Do not use, deprecated.
</ins><span class="cx"> *
</span><del>- * Works on arrays.
</del><ins>+ * Use esc_sql() or wpdb::prepare() instead.
</ins><span class="cx"> *
</span><span class="cx"> * @since 0.71
</span><del>- * @param string|array $data to escape
- * @return string|array escaped as query safe string
</del><ins>+ * @deprecated 3.6.0
+ * @see wpdb::prepare()
+ * @see esc_sql()
+ *
+ * @param mixed $data
+ * @return mixed
</ins><span class="cx"> */
</span><span class="cx"> function escape( $data ) {
</span><ins>+ if ( func_num_args() === 1 )
+ _deprecated_function( __METHOD__, '3.6', 'wpdb::prepare() or esc_sql()' );
</ins><span class="cx"> if ( is_array( $data ) ) {
</span><del>- foreach ( (array) $data as $k => $v ) {
</del><ins>+ foreach ( $data as $k => $v ) {
</ins><span class="cx"> if ( is_array( $v ) )
</span><del>- $data[$k] = $this->escape( $v );
</del><ins>+ $data[$k] = $this->escape( $v, 'recursive' );
</ins><span class="cx"> else
</span><del>- $data[$k] = $this->_weak_escape( $v );
</del><ins>+ $data[$k] = $this->_weak_escape( $v, 'internal' );
</ins><span class="cx"> }
</span><span class="cx"> } else {
</span><del>- $data = $this->_weak_escape( $data );
</del><ins>+ $data = $this->_weak_escape( $data, 'internal' );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> return $data;
</span></span></pre>
</div>
</div>
</body>
</html>