<!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>[53452] trunk/src/wp-includes/formatting.php: Formatting: Make `sanitize_url()` the recommended function for sanitizing a URL.</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/53452">53452</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/53452","name":"Review Commit"}}</script></dd>

<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>

<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-05-31 15:15:58 +0000 (Tue, 31 May 2022)</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: Make `sanitize_url()` the recommended function for sanitizing a URL.

A general security rule is "Sanitize when you save, escape when you echo".

In WordPress 5.9, `sanitize_url()` was un-deprecated in order to better align with the naming of other sanitizing functions, while still being an alias for `esc_url_raw()`.

This commit reverses the order and turns `esc_url_raw()` into a wrapper for `sanitize_url()`, making the latter the canonical function call and aiming to improve performance by reducing the number of function calls required when using the recommended technique.

Follow-up to <a href="https://core.trac.wordpress.org/changeset/11383">[11383]</a>, <a href="https://core.trac.wordpress.org/changeset/13096">[13096]</a>, <a href="https://core.trac.wordpress.org/changeset/51597">[51597]</a>.

Props benjgrolleau, peterwilsoncc, SergeyBiryukov.

See <a href="https://core.trac.wordpress.org/ticket/55852">#55852</a>.</pre>

<h3>Modified Paths</h3>

<ul>

<li><a href="#trunksrcwpincludesformattingphp">trunk/src/wp-includes/formatting.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      2022-05-30 14:52:00 UTC (rev 53451)

+++ trunk/src/wp-includes/formatting.php        2022-05-31 15:15:58 UTC (rev 53452)

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4458,31 +4458,32 @@

</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"> /**

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Performs esc_url() for database or redirect usage.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Sanitizes a URL for database or redirect usage.

</ins><span class="cx" style="display: block; padding: 0 10px">  *

<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * This function is an alias for sanitize_url().

+ *

</ins><span class="cx" style="display: block; padding: 0 10px">  * @since 2.8.0

<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.1.0 Turned into an alias for sanitize_url().

</ins><span class="cx" style="display: block; padding: 0 10px">  *

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @see esc_url()

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @see sanitize_url()

</ins><span class="cx" style="display: block; padding: 0 10px">  *

<span class="cx" style="display: block; padding: 0 10px">  * @param string   $url       The URL to be cleaned.

<span class="cx" style="display: block; padding: 0 10px">  * @param string[] $protocols Optional. An array of acceptable protocols.

<span class="cx" style="display: block; padding: 0 10px">  *                            Defaults to return value of wp_allowed_protocols().

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return string The cleaned URL after esc_url() is run with the 'db' context.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return string The cleaned URL after sanitize_url() is run.

</ins><span class="cx" style="display: block; padding: 0 10px">  */

</span><span class="cx" style="display: block; padding: 0 10px"> function esc_url_raw( $url, $protocols = null ) {

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-        return esc_url( $url, $protocols, 'db' );

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return sanitize_url( $url, $protocols );

</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"> /**

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Performs esc_url() for database or redirect usage.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Sanitizes a URL for database or redirect usage.

</ins><span class="cx" style="display: block; padding: 0 10px">  *

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * This function is an alias for esc_url_raw().

- *

</del><span class="cx" style="display: block; padding: 0 10px">  * @since 2.3.1

<span class="cx" style="display: block; padding: 0 10px">  * @since 2.8.0 Deprecated in favor of esc_url_raw().

</span><span class="cx" style="display: block; padding: 0 10px">  * @since 5.9.0 Restored (un-deprecated).

</span><span class="cx" style="display: block; padding: 0 10px">  *

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @see esc_url_raw()

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @see esc_url()

</ins><span class="cx" style="display: block; padding: 0 10px">  *

<span class="cx" style="display: block; padding: 0 10px">  * @param string   $url       The URL to be cleaned.

<span class="cx" style="display: block; padding: 0 10px">  * @param string[] $protocols Optional. An array of acceptable protocols.

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4490,7 +4491,7 @@

<span class="cx" style="display: block; padding: 0 10px">  * @return string The cleaned URL after esc_url() is run with the 'db' context.

</span><span class="cx" style="display: block; padding: 0 10px">  */

</span><span class="cx" style="display: block; padding: 0 10px"> function sanitize_url( $url, $protocols = null ) {

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-        return esc_url_raw( $url, $protocols );

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return esc_url( $url, $protocols, 'db' );

</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>