<!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>[48478] trunk/src/wp-includes/kses.php: Docs: Synchronize description for the `$allowed_html` parameter of various KSES functions.</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/48478">48478</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/48478","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>2020-07-14 12:39:16 +0000 (Tue, 14 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'>Docs: Synchronize description for the `$allowed_html` parameter of various KSES functions.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/43016">[43016]</a>.
Props Christian1012, jdgrimes, markparnell.
Fixes <a href="https://core.trac.wordpress.org/ticket/39542">#39542</a>. See <a href="https://core.trac.wordpress.org/ticket/33801">#33801</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesksesphp">trunk/src/wp-includes/kses.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesksesphp"></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/kses.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/kses.php 2020-07-14 12:31:22 UTC (rev 48477)
+++ trunk/src/wp-includes/kses.php 2020-07-14 12:39:16 UTC (rev 48478)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -736,8 +736,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $string Text content to filter.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array[]|string $allowed_html An array of allowed HTML elements and attributes, or a
- * context name such as 'post'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array[]|string $allowed_html An array of allowed HTML elements and attributes,
+ * or a context name such as 'post'. See wp_kses_allowed_html()
+ * for the list of accepted context names.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string[] $allowed_protocols Array of allowed URL protocols.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string Filtered content containing only the allowed HTML.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -745,9 +746,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $allowed_protocols ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $allowed_protocols = wp_allowed_protocols();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $string = wp_kses_no_null( $string, array( 'slash_zero' => 'keep' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $string = wp_kses_normalize_entities( $string );
</span><span class="cx" style="display: block; padding: 0 10px"> $string = wp_kses_hook( $string, $allowed_html, $allowed_protocols );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> return wp_kses_split( $string, $allowed_html, $allowed_protocols );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -909,20 +912,24 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $string Content to filter through KSES.
- * @param array[]|string $allowed_html List of allowed HTML elements.
- * @param string[] $allowed_protocols Array of allowed URL protocols.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $string Content to filter through KSES.
+ * @param array[]|string $allowed_html An array of allowed HTML elements and attributes,
+ * or a context name such as 'post'. See wp_kses_allowed_html()
+ * for the list of accepted context names.
+ * @param string[] $allowed_protocols Array of allowed URL protocols.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string Filtered content through {@see 'pre_kses'} hook.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_kses_hook( $string, $allowed_html, $allowed_protocols ) {
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Filters content to be run through kses.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filters content to be run through KSES.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.3.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $string Content to run through KSES.
- * @param array[]|string $allowed_html Allowed HTML elements.
- * @param string[] $allowed_protocols Array of allowed URL protocols.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $string Content to filter through KSES.
+ * @param array[]|string $allowed_html An array of allowed HTML elements and attributes,
+ * or a context name such as 'post'. See wp_kses_allowed_html()
+ * for the list of accepted context names.
+ * @param string[] $allowed_protocols Array of allowed URL protocols.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'pre_kses', $string, $allowed_html, $allowed_protocols );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -945,18 +952,23 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @global array $pass_allowed_html
- * @global array $pass_allowed_protocols
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global array[]|string $pass_allowed_html An array of allowed HTML elements and attributes,
+ * or a context name such as 'post'.
+ * @global string[] $pass_allowed_protocols Array of allowed URL protocols.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $string Content to filter.
- * @param array $allowed_html Allowed HTML elements.
- * @param string[] $allowed_protocols Array of allowed URL protocols.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $string Content to filter.
+ * @param array[]|string $allowed_html An array of allowed HTML elements and attributes,
+ * or a context name such as 'post'. See wp_kses_allowed_html()
+ * for the list of accepted context names.
+ * @param string[] $allowed_protocols Array of allowed URL protocols.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string Content with fixed HTML tags
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_kses_split( $string, $allowed_html, $allowed_protocols ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $pass_allowed_html, $pass_allowed_protocols;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $pass_allowed_html = $allowed_html;
</span><span class="cx" style="display: block; padding: 0 10px"> $pass_allowed_protocols = $allowed_protocols;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> return preg_replace_callback( '%(<!--.*?(-->|$))|(<[^>]*(>|$)|>)%', '_wp_kses_split_callback', $string );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1017,13 +1029,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @access private
</span><span class="cx" style="display: block; padding: 0 10px"> * @ignore
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @global array $pass_allowed_html
- * @global array $pass_allowed_protocols
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global array[]|string $pass_allowed_html An array of allowed HTML elements and attributes,
+ * or a context name such as 'post'.
+ * @global string[] $pass_allowed_protocols Array of allowed URL protocols.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function _wp_kses_split_callback( $match ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $pass_allowed_html, $pass_allowed_protocols;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> return wp_kses_split2( $match[0], $pass_allowed_html, $pass_allowed_protocols );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1043,9 +1057,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @ignore
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $string Content to filter.
- * @param array $allowed_html Allowed HTML elements.
- * @param string[] $allowed_protocols Array of allowed URL protocols.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $string Content to filter.
+ * @param array[]|string $allowed_html An array of allowed HTML elements and attributes,
+ * or a context name such as 'post'. See wp_kses_allowed_html()
+ * for the list of accepted context names.
+ * @param string[] $allowed_protocols Array of allowed URL protocols.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string Fixed HTML element
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_kses_split2( $string, $allowed_html, $allowed_protocols ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1109,10 +1125,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $element HTML element/tag.
- * @param string $attr HTML attributes from HTML element to closing HTML element tag.
- * @param array $allowed_html Allowed HTML elements.
- * @param string[] $allowed_protocols Array of allowed URL protocols.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $element HTML element/tag.
+ * @param string $attr HTML attributes from HTML element to closing HTML element tag.
+ * @param array[]|string $allowed_html An array of allowed HTML elements and attributes,
+ * or a context name such as 'post'. See wp_kses_allowed_html()
+ * for the list of accepted context names.
+ * @param string[] $allowed_protocols Array of allowed URL protocols.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string Sanitized HTML element.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_kses_attr( $element, $attr, $allowed_html, $allowed_protocols ) {
</span></span></pre>
</div>
</div>
</body>
</html>