<!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>[BuddyPress][12361] trunk/src/bp-xprofile/bp-xprofile-filters.php: XProfile: When displaying field data, sanitize HTML properly for richtext.</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="http://buddypress.trac.wordpress.org/changeset/12361">12361</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/12361","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>boonebgorges</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2019-03-21 15:06:44 +0000 (Thu, 21 Mar 2019)</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'>XProfile: When displaying field data, sanitize HTML properly for richtext.
Previously, kses display filters were not always provided with enough
information to determine whether the current field supports rich text,
and thus ought to be filtered against an extended HTML tag whitelist.
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/8063">#8063</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpxprofilebpxprofilefiltersphp">trunk/src/bp-xprofile/bp-xprofile-filters.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpxprofilebpxprofilefiltersphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-xprofile/bp-xprofile-filters.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-xprofile/bp-xprofile-filters.php 2019-03-21 14:25:00 UTC (rev 12360)
+++ trunk/src/bp-xprofile/bp-xprofile-filters.php 2019-03-21 15:06:44 UTC (rev 12361)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -12,12 +12,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Exit if accessed directly.
</span><span class="cx" style="display: block; padding: 0 10px"> defined( 'ABSPATH' ) || exit;
</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_filter( 'bp_get_the_profile_group_name', 'wp_filter_kses', 1 );
-add_filter( 'bp_get_the_profile_group_description', 'wp_filter_kses', 1 );
-add_filter( 'bp_get_the_profile_field_value', 'xprofile_filter_kses', 1 );
-add_filter( 'bp_get_the_profile_field_name', 'wp_filter_kses', 1 );
-add_filter( 'bp_get_the_profile_field_edit_value', 'wp_filter_kses', 1 );
-add_filter( 'bp_get_the_profile_field_description', 'wp_filter_kses', 1 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+add_filter( 'bp_get_the_profile_group_name', 'wp_filter_kses', 1 );
+add_filter( 'bp_get_the_profile_group_description', 'wp_filter_kses', 1 );
+add_filter( 'bp_get_the_profile_field_name', 'wp_filter_kses', 1 );
+add_filter( 'bp_get_the_profile_field_edit_value', 'wp_filter_kses', 1 );
+add_filter( 'bp_get_the_profile_field_description', 'wp_filter_kses', 1 );
+add_filter( 'bp_get_the_profile_field_value', 'xprofile_sanitize_data_value_before_display', 1, 3 );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'bp_get_the_profile_field_value', 'wptexturize' );
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'bp_get_the_profile_field_value', 'convert_chars' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -40,7 +40,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'bp_get_the_profile_field_name', 'stripslashes' );
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'bp_get_the_profile_field_description', 'stripslashes' );
</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_filter( 'xprofile_get_field_data', 'xprofile_filter_kses', 1 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+add_filter( 'xprofile_get_field_data', 'xprofile_sanitize_data_value_before_display_from_get_field_data', 1, 2 );
</ins><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'xprofile_field_name_before_save', 'wp_filter_kses', 1 );
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'xprofile_field_description_before_save', 'wp_filter_kses', 1 );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -116,24 +116,31 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Run profile field values through kses with filterable allowed tags.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.5.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 2.1.0 Added `$data_obj` parameter.
+ * @since 5.0.0 Added `$field_id` parameter.
</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 $content Content to filter.
- * @param object|null $data_obj The BP_XProfile_ProfileData object.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $content Content to filter.
+ * @param BP_XProfile_ProfileData|null $data_obj Optional. The BP_XProfile_ProfileData object.
+ * @param int|null $field_id Optional. The ID of the profile field.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string $content
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function xprofile_filter_kses( $content, $data_obj = null ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function xprofile_filter_kses( $content, $data_obj = null, $field_id = null ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> global $allowedtags;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $xprofile_allowedtags = $allowedtags;
</span><span class="cx" style="display: block; padding: 0 10px"> $xprofile_allowedtags['a']['rel'] = array();
</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 ( null === $field_id && $data_obj instanceof BP_XProfile_ProfileData ) {
+ $field_id = $data_obj->field_id;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // If the field supports rich text, we must allow tags that appear in wp_editor().
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $data_obj instanceof BP_XProfile_ProfileData && bp_xprofile_is_richtext_enabled_for_field( $data_obj->field_id ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $field_id && bp_xprofile_is_richtext_enabled_for_field( $field_id ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $richtext_tags = array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'img' => array( 'id' => 1, 'class' => 1, 'src' => 1, 'alt' => 1, 'width' => 1, 'height' => 1 ),
- 'ul' => array( 'id' => 1, 'class' => 1 ),
- 'ol' => array( 'id' => 1, 'class' => 1 ),
- 'li' => array( 'id' => 1, 'class' => 1 ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'img' => array( 'src' => 1, 'alt' => 1, 'width' => 1, 'height' => 1 ),
+ 'ul' => array(),
+ 'ol' => array(),
+ 'li' => array(),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'span' => array( 'style' => 1 ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'p' => array( 'style' => 1 ),
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -145,15 +152,43 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the allowed tags for use within xprofile_filter_kses().
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.5.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 2.1.0 Added `$data_obj` parameter.
+ * @since 5.0.0 Added `$field_id` parameter.
</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 array $xprofile_allowedtags Array of allowed tags for profile field values.
- * @param BP_XProfile_ProfileData $data_obj The BP_XProfile_ProfileData object.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $xprofile_allowedtags Array of allowed tags for profile field values.
+ * @param BP_XProfile_ProfileData|null $data_obj The BP_XProfile_ProfileData object.
+ * @param int|null $field_id The ID of the profile field.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $xprofile_allowedtags = apply_filters( 'xprofile_allowed_tags', $xprofile_allowedtags, $data_obj );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $xprofile_allowedtags = apply_filters( 'xprofile_allowed_tags', $xprofile_allowedtags, $data_obj, $field_id );
</ins><span class="cx" style="display: block; padding: 0 10px"> return wp_kses( $content, $xprofile_allowedtags );
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filters profile field values for whitelisted HTML.
+ *
+ * @since 5.0.0
+ *
+ * @param string $value Field value.
+ * @param string $type Field type.
+ * @param int $field_id Field ID.
+ */
+function xprofile_sanitize_data_value_before_display( $value, $type, $field_id ) {
+ return xprofile_filter_kses( $value, null, $field_id );
+}
+
+/**
+ * Filters profile field values for whitelisted HTML, when coming from xprofile_get_field_data().
+ *
+ * @since 5.0.0
+ *
+ * @param string $value Field value.
+ * @param int $field_id Field ID.
+ */
+function xprofile_sanitize_data_value_before_display_from_get_field_data( $value, $field_id ) {
+ return xprofile_filter_kses( $value, $field_id );
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Safely runs profile field data through kses and force_balance_tags.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.2.6
</span></span></pre>
</div>
</div>
</body>
</html>