<!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][8082] trunk: Improve behavior or bp_member_profile_data() when used outside of members loop</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://buddypress.trac.wordpress.org/changeset/8082">8082</a></dd>
<dt>Author</dt> <dd>boonebgorges</dd>
<dt>Date</dt> <dd>2014-03-08 12:33:18 +0000 (Sat, 08 Mar 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Improve behavior or bp_member_profile_data() when used outside of members loop
Our documentation suggests the use of bp_member_profile_data() to pull up
miscellaneous pieces of user profile data anywhere in a template. Technically,
this works, but the internals of the function made a few assumptions that it
would only be used in the context of a bp_has_members() loop. This would result
in needless PHP notices when using the function outside of a loop context.
This changeset introduces checks to ensure that the $members_template global
is only manipulated if it exists, making the function safe to use anywhere.
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/5334">#5334</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpmembersbpmemberstemplatephp">trunk/bp-members/bp-members-template.php</a></li>
<li><a href="#trunkteststestcasesxprofilefunctionsphp">trunk/tests/testcases/xprofile/functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpmembersbpmemberstemplatephp"></a>
<div class="modfile"><h4>Modified: trunk/bp-members/bp-members-template.php (8081 => 8082)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-members/bp-members-template.php 2014-03-08 12:33:15 UTC (rev 8081)
+++ trunk/bp-members/bp-members-template.php 2014-03-08 12:33:18 UTC (rev 8082)
</span><span class="lines">@@ -681,13 +681,25 @@
</span><span class="cx"> $r = wp_parse_args( $args, $defaults );
</span><span class="cx"> extract( $r, EXTR_SKIP );
</span><span class="cx">
</span><del>- // Populate the user if it hasn't been already.
- if ( empty( $members_template->member->profile_data ) && method_exists( 'BP_XProfile_ProfileData', 'get_all_for_user' ) )
- $members_template->member->profile_data = BP_XProfile_ProfileData::get_all_for_user( $user_id );
</del><ins>+ // If we're in a members loop, get the data from the global
+ if ( ! empty( $members_template->member->profile_data ) ) {
+ $profile_data = $members_template->member->profile_data;
+ }
</ins><span class="cx">
</span><ins>+ // Otherwise query for the data
+ if ( empty( $profile_data ) && method_exists( 'BP_XProfile_ProfileData', 'get_all_for_user' ) ) {
+ $profile_data = BP_XProfile_ProfileData::get_all_for_user( $user_id );
+ }
+
+ // If we're in the members loop, but the profile data has not
+ // been loaded into the global, cache it there for later use
+ if ( ! empty( $members_template->member ) && empty( $members_template->member->profile_data ) ) {
+ $members_template->member->profile_data = $profile_data;
+ }
+
</ins><span class="cx"> // Get the field data if there is data to get
</span><del>- if ( ! empty( $members_template->member->profile_data ) && ! empty( $members_template->member->profile_data[$field]['field_type'] ) && ! empty( $members_template->member->profile_data[$field]['field_data'] ) )
- $data = xprofile_format_profile_field( $members_template->member->profile_data[$field]['field_type'], $members_template->member->profile_data[$field]['field_data'] );
</del><ins>+ if ( ! empty( $profile_data ) && ! empty( $profile_data[ $field ]['field_type'] ) && ! empty( $profile_data[ $field ]['field_data'] ) )
+ $data = xprofile_format_profile_field( $profile_data[ $field ]['field_type'], $profile_data[ $field ]['field_data'] );
</ins><span class="cx">
</span><span class="cx"> return apply_filters( 'bp_get_member_profile_data', $data );
</span><span class="cx"> }
</span></span></pre></div>
<a id="trunkteststestcasesxprofilefunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/tests/testcases/xprofile/functions.php (8081 => 8082)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/testcases/xprofile/functions.php 2014-03-08 12:33:15 UTC (rev 8081)
+++ trunk/tests/testcases/xprofile/functions.php 2014-03-08 12:33:18 UTC (rev 8082)
</span><span class="lines">@@ -495,4 +495,50 @@
</span><span class="cx"> bp_xprofile_add_meta( $g, 'group', 'foo', 'bar' );
</span><span class="cx"> $this->assertNotEmpty( bp_xprofile_add_meta( $g, 'group', 'foo', 'baz' ) );
</span><span class="cx"> }
</span><ins>+
+ /**
+ * @group bp_get_member_profile_data
+ */
+ public function test_bp_get_member_profile_data_inside_loop() {
+ $u = $this->create_user();
+ $g = $this->factory->xprofile_group->create();
+ $f = $this->factory->xprofile_field->create( array(
+ 'field_group_id' => $g,
+ 'type' => 'textbox',
+ 'name' => 'Neato',
+ ) );
+ xprofile_set_field_data( $f, $u, 'foo' );
+
+ if ( bp_has_members() ) : while ( bp_members() ) : bp_the_member();
+ $found = bp_get_member_profile_data( array(
+ 'user_id' => $u,
+ 'field' => 'Neato',
+ ) );
+ endwhile; endif;
+
+ // Cleanup
+ unset( $GLOBALS['members_template'] );
+
+ $this->assertSame( 'foo', $found );
+ }
+ /**
+ * @group bp_get_member_profile_data
+ */
+ public function test_bp_get_member_profile_data_outside_of_loop() {
+ $u = $this->create_user();
+ $g = $this->factory->xprofile_group->create();
+ $f = $this->factory->xprofile_field->create( array(
+ 'field_group_id' => $g,
+ 'type' => 'textbox',
+ 'name' => 'Kewl',
+ ) );
+ xprofile_set_field_data( $f, $u, 'foo' );
+
+ $found = bp_get_member_profile_data( array(
+ 'user_id' => $u,
+ 'field' => 'Kewl',
+ ) );
+
+ $this->assertSame( 'foo', $found );
+ }
</ins><span class="cx"> }
</span></span></pre>
</div>
</div>
</body>
</html>