<!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][11316] trunk/src/bp-xprofile: XProfile: More consistent cache behavior when fetching user data.</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" 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/11316">11316</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/11316","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>2016-12-21 02:42:05 +0000 (Wed, 21 Dec 2016)</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: More consistent cache behavior when fetching user data.
* Inside of a profile group loop (`BP_XProfile_Group::get()`), don't fetch user data when pulling up `BP_XProfile_Field` objects. In the absence of finer-grained information about users, fetching a field object grabs the data associated with the logged-in user. But in many cases, the logged-in user is irrelevant to the fields being looped over, so there's no benefit to pulling up this data. (When necessary - `fetch_data` - the data is queried separately, later in the `get()` method.)
* When caching database misses for a data query (because the specifed user doesn't have anything filled in for the given field), store the `field_id` and `user_id` properties on the cached object. This ensures that values are properly associated with their fields when being displayed.
These changes resolve an issue where cached data for the logged-in user
can be shown erroneously on another user's profile, when the other user
doesn't have a value for a given field.
Props m_uysl, r-a-y.
See <a href="http://buddypress.trac.wordpress.org/ticket/6091">#6091</a>. Fixes <a href="http://buddypress.trac.wordpress.org/ticket/7401">#7401</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpxprofilebpxprofilefunctionsphp">trunk/src/bp-xprofile/bp-xprofile-functions.php</a></li>
<li><a href="#trunksrcbpxprofileclassesclassbpxprofilefieldphp">trunk/src/bp-xprofile/classes/class-bp-xprofile-field.php</a></li>
<li><a href="#trunksrcbpxprofileclassesclassbpxprofilegroupphp">trunk/src/bp-xprofile/classes/class-bp-xprofile-group.php</a></li>
<li><a href="#trunksrcbpxprofileclassesclassbpxprofileprofiledataphp">trunk/src/bp-xprofile/classes/class-bp-xprofile-profiledata.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpxprofilebpxprofilefunctionsphp"></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-functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-xprofile/bp-xprofile-functions.php 2016-12-20 15:21:18 UTC (rev 11315)
+++ trunk/src/bp-xprofile/bp-xprofile-functions.php 2016-12-21 02:42:05 UTC (rev 11316)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -282,18 +282,24 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Get a profile field object.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.1.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 2.8.0 Added `$user_id` and `$get_data` parameters.
</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 int|object $field ID of the field or object representing field data.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int|object $field ID of the field or object representing field data.
+ * @param int $user_id Optional. ID of the user associated with the field.
+ * Ignored if `$get_data` is false. If `$get_data` is
+ * true, but no `$user_id` is provided, defaults to
+ * logged-in user ID.
+ * @param bool $get_data Whether to fetch data for the specified `$user_id`.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return BP_XProfile_Field|null Field object if found, otherwise null.
</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_get_field( $field ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function xprofile_get_field( $field, $user_id = null, $get_data = true ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $field instanceof BP_XProfile_Field ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $_field = $field;
</span><span class="cx" style="display: block; padding: 0 10px"> } elseif ( is_object( $field ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $_field = new BP_XProfile_Field();
</span><span class="cx" style="display: block; padding: 0 10px"> $_field->fill_data( $field );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $_field = BP_XProfile_Field::get_instance( $field );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $_field = BP_XProfile_Field::get_instance( $field, $user_id, $get_data );
</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"> if ( ! $_field ) {
</span></span></pre></div>
<a id="trunksrcbpxprofileclassesclassbpxprofilefieldphp"></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/classes/class-bp-xprofile-field.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-xprofile/classes/class-bp-xprofile-field.php 2016-12-20 15:21:18 UTC (rev 11315)
+++ trunk/src/bp-xprofile/classes/class-bp-xprofile-field.php 2016-12-21 02:42:05 UTC (rev 11316)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -227,13 +227,19 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Retrieve a `BP_XProfile_Field` instance.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.4.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 2.8.0 Added `$user_id` and `$get_data` parameters.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @static
</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 int $field_id ID of the field.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $field_id ID of the field.
+ * @param int $user_id Optional. ID of the user associated with the field.
+ * Ignored if `$get_data` is false. If `$get_data` is
+ * true, but no `$user_id` is provided, defaults to
+ * logged-in user ID.
+ * @param bool $get_data Whether to fetch data for the specified `$user_id`.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return BP_XProfile_Field|false Field object if found, otherwise false.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public static function get_instance( $field_id ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public static function get_instance( $field_id, $user_id = null, $get_data = true ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> global $wpdb;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $field_id = (int) $field_id;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -241,7 +247,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</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">- return new self( $field_id );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return new self( $field_id, $user_id, $get_data );
</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>
<a id="trunksrcbpxprofileclassesclassbpxprofilegroupphp"></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/classes/class-bp-xprofile-group.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-xprofile/classes/class-bp-xprofile-group.php 2016-12-20 15:21:18 UTC (rev 11315)
+++ trunk/src/bp-xprofile/classes/class-bp-xprofile-group.php 2016-12-21 02:42:05 UTC (rev 11316)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -396,7 +396,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Pull field objects from the cache.
</span><span class="cx" style="display: block; padding: 0 10px"> $fields = array();
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $field_ids as $field_id ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $fields[] = xprofile_get_field( $field_id );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $fields[] = xprofile_get_field( $field_id, null, false );
</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"> // Store field IDs for meta cache priming.
</span></span></pre></div>
<a id="trunksrcbpxprofileclassesclassbpxprofileprofiledataphp"></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/classes/class-bp-xprofile-profiledata.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-xprofile/classes/class-bp-xprofile-profiledata.php 2016-12-20 15:21:18 UTC (rev 11315)
+++ trunk/src/bp-xprofile/classes/class-bp-xprofile-profiledata.php 2016-12-21 02:42:05 UTC (rev 11316)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -323,7 +323,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $d = new stdClass;
</span><span class="cx" style="display: block; padding: 0 10px"> $d->id = '';
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $d->user_id = '';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $d->user_id = $user_id;
</ins><span class="cx" style="display: block; padding: 0 10px"> $d->field_id = $field_id;
</span><span class="cx" style="display: block; padding: 0 10px"> $d->value = '';
</span><span class="cx" style="display: block; padding: 0 10px"> $d->last_updated = '';
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -489,7 +489,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $d = new stdClass;
</span><span class="cx" style="display: block; padding: 0 10px"> $d->id = '';
</span><span class="cx" style="display: block; padding: 0 10px"> $d->user_id = $id;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $d->field_id = '';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $d->field_id = $field_id;
</ins><span class="cx" style="display: block; padding: 0 10px"> $d->value = '';
</span><span class="cx" style="display: block; padding: 0 10px"> $d->last_updated = '';
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>