<!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][8133] trunk: Use WP's array format for get_meta() functions when no $meta_key is provided</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/8133">8133</a></dd>
<dt>Author</dt> <dd>boonebgorges</dd>
<dt>Date</dt> <dd>2014-03-14 01:04:58 +0000 (Fri, 14 Mar 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Use WP's array format for get_meta() functions when no $meta_key is provided
Passing only an object_id to a get_meta() function in WP will return an array
of arrays, keyed by meta_keys, each containing a list of meta_values for that
meta_key. BP's get_meta() functions were inconsistent in this regard: some
returned arrays of stdClass, some returned one-d arrays of meta_values. All
returned values that were practically of little use, because they didn't have
enough information about the located data to make it useful.
This changeset aligns BP's get_meta() functions with WP's. We now allow the
return value of get_metadata() to pass through untouched in all cases. Unit
tests have been updated as necessary.
See <a href="http://buddypress.trac.wordpress.org/ticket/5399">#5399</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpactivitybpactivityfunctionsphp">trunk/bp-activity/bp-activity-functions.php</a></li>
<li><a href="#trunkbpblogsbpblogsfunctionsphp">trunk/bp-blogs/bp-blogs-functions.php</a></li>
<li><a href="#trunkbpgroupsbpgroupsfunctionsphp">trunk/bp-groups/bp-groups-functions.php</a></li>
<li><a href="#trunkbpxprofilebpxprofilefunctionsphp">trunk/bp-xprofile/bp-xprofile-functions.php</a></li>
<li><a href="#trunkteststestcasesactivityfunctionsphp">trunk/tests/testcases/activity/functions.php</a></li>
<li><a href="#trunkteststestcasesblogsfunctionsphp">trunk/tests/testcases/blogs/functions.php</a></li>
<li><a href="#trunkteststestcasesgroupsfunctionsphp">trunk/tests/testcases/groups/functions.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="trunkbpactivitybpactivityfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-activity/bp-activity-functions.php (8132 => 8133)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-activity/bp-activity-functions.php 2014-03-14 00:50:26 UTC (rev 8132)
+++ trunk/bp-activity/bp-activity-functions.php 2014-03-14 01:04:58 UTC (rev 8133)
</span><span class="lines">@@ -579,7 +579,7 @@
</span><span class="cx"> // Legacy - if no meta_key is passed, delete all for the item
</span><span class="cx"> if ( empty( $meta_key ) ) {
</span><span class="cx"> $all_meta = bp_activity_get_meta( $activity_id );
</span><del>- $keys = ! empty( $all_meta ) ? wp_list_pluck( $all_meta, 'meta_key' ) : array();
</del><ins>+ $keys = ! empty( $all_meta ) ? array_keys( $all_meta ) : array();
</ins><span class="cx">
</span><span class="cx"> // With no meta_key, ignore $delete_all
</span><span class="cx"> $delete_all = false;
</span><span class="lines">@@ -625,26 +625,6 @@
</span><span class="cx"> $retval = get_metadata( 'activity', $activity_id, $meta_key, $single );
</span><span class="cx"> remove_filter( 'query', 'bp_filter_metaid_column_name' );
</span><span class="cx">
</span><del>- // Legacy - If fetching all meta for a group, just return the first
- // of each found value
- if ( empty( $meta_key ) ) {
- $values = array();
- foreach ( (array) $retval as $rkey => $rvalue ) {
- $rvalue = array_reverse( $rvalue );
- $found = new stdClass;
- $found->meta_key = $rkey;
- $found->meta_value = array_pop( $rvalue );
- $values[] = $found;
- }
-
- // If nothing was found, return empty string
- if ( empty( $values ) ) {
- $retval = '';
- } else {
- $retval = $values;
- }
- }
-
</del><span class="cx"> // Filter result before returning
</span><span class="cx"> return apply_filters( 'bp_activity_get_meta', $retval, $activity_id, $meta_key, $single );
</span><span class="cx"> }
</span></span></pre></div>
<a id="trunkbpblogsbpblogsfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-blogs/bp-blogs-functions.php (8132 => 8133)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-blogs/bp-blogs-functions.php 2014-03-14 00:50:26 UTC (rev 8132)
+++ trunk/bp-blogs/bp-blogs-functions.php 2014-03-14 01:04:58 UTC (rev 8133)
</span><span class="lines">@@ -895,16 +895,6 @@
</span><span class="cx"> $retval = get_metadata( 'blog', $blog_id, $meta_key, $single );
</span><span class="cx"> remove_filter( 'query', 'bp_filter_metaid_column_name' );
</span><span class="cx">
</span><del>- // Legacy - If no meta_key is passed, return only the found values,
- // not a structured array
- if ( empty( $meta_key ) && is_array( $retval ) ) {
- $values = array();
- foreach ( $retval as $value ) {
- $values[] = array_pop( $value );
- }
- $retval = $values;
- }
-
</del><span class="cx"> return $retval;
</span><span class="cx"> }
</span><span class="cx">
</span></span></pre></div>
<a id="trunkbpgroupsbpgroupsfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-groups/bp-groups-functions.php (8132 => 8133)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-groups/bp-groups-functions.php 2014-03-14 00:50:26 UTC (rev 8132)
+++ trunk/bp-groups/bp-groups-functions.php 2014-03-14 01:04:58 UTC (rev 8133)
</span><span class="lines">@@ -1074,15 +1074,6 @@
</span><span class="cx"> $retval = get_metadata( 'group', $group_id, $meta_key, $single );
</span><span class="cx"> remove_filter( 'query', 'bp_filter_metaid_column_name' );
</span><span class="cx">
</span><del>- // Legacy - If fetching all meta for a group, just return values
- if ( empty( $meta_key ) ) {
- $values = array();
- foreach ( (array) $retval as $r ) {
- $values[] = array_pop( $r );
- }
- $retval = $values;
- }
-
</del><span class="cx"> return $retval;
</span><span class="cx"> }
</span><span class="cx">
</span></span></pre></div>
<a id="trunkbpxprofilebpxprofilefunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-xprofile/bp-xprofile-functions.php (8132 => 8133)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-xprofile/bp-xprofile-functions.php 2014-03-14 00:50:26 UTC (rev 8132)
+++ trunk/bp-xprofile/bp-xprofile-functions.php 2014-03-14 01:04:58 UTC (rev 8133)
</span><span class="lines">@@ -640,17 +640,6 @@
</span><span class="cx"> remove_filter( 'query', 'bp_filter_metaid_column_name' );
</span><span class="cx"> remove_filter( 'query', 'bp_xprofile_filter_meta_query' );
</span><span class="cx">
</span><del>- // Legacy - if no meta_key is provided, return just the located
- // values (not a structured array)
- if ( empty( $meta_key ) && ! empty( $retval ) ) {
- $values = array();
- foreach ( $retval as $v ) {
- $values[] = array_pop( $v );
- }
-
- $retval = $values;
- }
-
</del><span class="cx"> return $retval;
</span><span class="cx"> }
</span><span class="cx">
</span></span></pre></div>
<a id="trunkteststestcasesactivityfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/tests/testcases/activity/functions.php (8132 => 8133)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/testcases/activity/functions.php 2014-03-14 00:50:26 UTC (rev 8132)
+++ trunk/tests/testcases/activity/functions.php 2014-03-14 01:04:58 UTC (rev 8133)
</span><span class="lines">@@ -82,9 +82,9 @@
</span><span class="cx"> $m3 = bp_activity_get_meta( $comment_two );
</span><span class="cx">
</span><span class="cx"> // test if activity meta entries still exist
</span><del>- $this->assertEquals( false, $m1 );
- $this->assertEquals( false, $m2 );
- $this->assertEquals( false, $m3 );
</del><ins>+ $this->assertEmpty( $m1 );
+ $this->assertEmpty( $m2 );
+ $this->assertEmpty( $m3 );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -250,17 +250,13 @@
</span><span class="cx"> bp_activity_update_meta( $a, 'foo', 'bar' );
</span><span class="cx"> bp_activity_update_meta( $a, 'foo1', 'bar1' );
</span><span class="cx">
</span><del>- $am1 = new stdClass;
- $am1->meta_key = 'foo';
- $am1->meta_value = 'bar';
-
- $am2 = new stdClass;
- $am2->meta_key = 'foo1';
- $am2->meta_value = 'bar1';
-
</del><span class="cx"> $expected = array(
</span><del>- $am1,
- $am2,
</del><ins>+ 'foo' => array(
+ 'bar',
+ ),
+ 'foo1' => array(
+ 'bar1',
+ ),
</ins><span class="cx"> );
</span><span class="cx">
</span><span class="cx"> $this->assertEquals( $expected, bp_activity_get_meta( $a ) );
</span></span></pre></div>
<a id="trunkteststestcasesblogsfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/tests/testcases/blogs/functions.php (8132 => 8133)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/testcases/blogs/functions.php 2014-03-14 00:50:26 UTC (rev 8132)
+++ trunk/tests/testcases/blogs/functions.php 2014-03-14 01:04:58 UTC (rev 8133)
</span><span class="lines">@@ -127,7 +127,16 @@
</span><span class="cx"> bp_blogs_update_blogmeta( 1, 'foo', 'bar' );
</span><span class="cx"> bp_blogs_update_blogmeta( 1, 'foo2', 'bar2' );
</span><span class="cx">
</span><del>- $this->assertSame( array( 'bar', 'bar2', ), bp_blogs_get_blogmeta( 1 ) );
</del><ins>+ $expected = array(
+ 'foo' => array(
+ 'bar',
+ ),
+ 'foo2' => array(
+ 'bar2',
+ ),
+ );
+
+ $this->assertSame( $expected, bp_blogs_get_blogmeta( 1 ) );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span></span></pre></div>
<a id="trunkteststestcasesgroupsfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/tests/testcases/groups/functions.php (8132 => 8133)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/testcases/groups/functions.php 2014-03-14 00:50:26 UTC (rev 8132)
+++ trunk/tests/testcases/groups/functions.php 2014-03-14 01:04:58 UTC (rev 8133)
</span><span class="lines">@@ -382,8 +382,12 @@
</span><span class="cx"> $found = array_slice( $metas, $count - 2 );
</span><span class="cx">
</span><span class="cx"> $expected = array(
</span><del>- 'bar',
- 'is cool',
</del><ins>+ 'foo' => array(
+ 'bar',
+ ),
+ 'Boone' => array(
+ 'is cool',
+ ),
</ins><span class="cx"> );
</span><span class="cx">
</span><span class="cx"> $this->assertSame( $expected, $found );
</span></span></pre></div>
<a id="trunkteststestcasesxprofilefunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/tests/testcases/xprofile/functions.php (8132 => 8133)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/testcases/xprofile/functions.php 2014-03-14 00:50:26 UTC (rev 8132)
+++ trunk/tests/testcases/xprofile/functions.php 2014-03-14 01:04:58 UTC (rev 8133)
</span><span class="lines">@@ -314,7 +314,14 @@
</span><span class="cx"> bp_xprofile_update_meta( $g, 'group', 'foo', 'bar' );
</span><span class="cx"> bp_xprofile_update_meta( $g, 'group', 'foo2', 'bar' );
</span><span class="cx">
</span><del>- $expected = array( 'bar', 'bar', );
</del><ins>+ $expected = array(
+ 'foo' => array(
+ 'bar',
+ ),
+ 'foo2' => array(
+ 'bar',
+ ),
+ );
</ins><span class="cx"> $this->assertSame( $expected, bp_xprofile_get_meta( $g, 'group' ) );
</span><span class="cx"> }
</span><span class="cx">
</span></span></pre>
</div>
</div>
</body>
</html>