Changeset 8082

Timestamp:

03/08/2014 12:33:18 PM (13 years ago)

Author:

boonebgorges

Message:

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 #5334

Location:

trunk

Files:

• bp-members/bp-members-template.php (modified) (1 diff)
• tests/testcases/xprofile/functions.php (modified) (1 diff)

trunk/bp-members/bp-members-template.php

@@ -682 +682 @@
                 extract( $r, EXTR_SKIP );
 
-                // 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 );
+                // 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;
+                }
+
+                // 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;
+                }
 
                 // Get the field data if there is data to get
-                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'] );
+                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'] );
 
                 return apply_filters( 'bp_get_member_profile_data', $data );

trunk/tests/testcases/xprofile/functions.php

@@ -496 +496 @@
                 $this->assertNotEmpty( bp_xprofile_add_meta( $g, 'group', 'foo', 'baz' ) );
         }
+
+        /**
+         * @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 );
+        }
 }