<!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][8131] trunk: Return an empty string from get_meta() functions when no value is found</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/8131">8131</a></dd>
<dt>Author</dt> <dd>boonebgorges</dd>
<dt>Date</dt> <dd>2014-03-14 00:37:28 +0000 (Fri, 14 Mar 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Return an empty string from get_meta() functions when no value is found
BP get_meta() functions have been inconsistent about the type of value returned
when no match is found for the object_id+meta_key combination. In some cases,
we followed WP's get_metadata() and returned an empty string. In others, we
returned false.
This changeset aligns all of our get_meta() functions with WP in this regard,
returning an empty string when no matching value is found. A boolean false is
still returned when invalid arguments are passed to the functions.
Relevant unit tests have been updated, including strict assertSame() checking
where appropriate.
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="#trunkteststestcasesactivityclassBP_Activity_Activityphp">trunk/tests/testcases/activity/class.BP_Activity_Activity.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 (8130 => 8131)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-activity/bp-activity-functions.php 2014-03-14 00:15:41 UTC (rev 8130)
+++ trunk/bp-activity/bp-activity-functions.php 2014-03-14 00:37:28 UTC (rev 8131)
</span><span class="lines">@@ -637,19 +637,14 @@
</span><span class="cx"> $values[] = $found;
</span><span class="cx"> }
</span><span class="cx">
</span><del>- // If nothing was found, return false
</del><ins>+ // If nothing was found, return empty string
</ins><span class="cx"> if ( empty( $values ) ) {
</span><del>- $retval = false;
</del><ins>+ $retval = '';
</ins><span class="cx"> } else {
</span><span class="cx"> $retval = $values;
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span><del>- // Legacy - On failure, expect false, not an empty string
- if ( '' === $retval ) {
- $retval = false;
- }
-
</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="trunkteststestcasesactivityclassBP_Activity_Activityphp"></a>
<div class="modfile"><h4>Modified: trunk/tests/testcases/activity/class.BP_Activity_Activity.php (8130 => 8131)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/testcases/activity/class.BP_Activity_Activity.php 2014-03-14 00:15:41 UTC (rev 8130)
+++ trunk/tests/testcases/activity/class.BP_Activity_Activity.php 2014-03-14 00:37:28 UTC (rev 8131)
</span><span class="lines">@@ -64,7 +64,7 @@
</span><span class="cx"> BP_Activity_Activity::delete_activity_meta_entries( $activity );
</span><span class="cx">
</span><span class="cx"> $meta = bp_activity_get_meta( $activity, 'Paul' );
</span><del>- $this->assertFalse( $meta );
</del><ins>+ $this->assertSame( '', $meta );
</ins><span class="cx"> }
</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 (8130 => 8131)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/testcases/activity/functions.php 2014-03-14 00:15:41 UTC (rev 8130)
+++ trunk/tests/testcases/activity/functions.php 2014-03-14 00:37:28 UTC (rev 8131)
</span><span class="lines">@@ -132,7 +132,7 @@
</span><span class="cx"> $krazy_key = ' f!@#$%^o *(){}o?+';
</span><span class="cx"> bp_activity_update_meta( $a, $krazy_key, 'bar' );
</span><span class="cx">
</span><del>- $this->assertEmpty( bp_activity_get_meta( $a, 'foo' ) );
</del><ins>+ $this->assertSame( '', bp_activity_get_meta( $a, 'foo' ) );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -154,7 +154,7 @@
</span><span class="cx"> public function test_bp_activity_update_meta_false_value_deletes() {
</span><span class="cx"> $a = $this->factory->activity->create();
</span><span class="cx"> bp_activity_update_meta( $a, 'foo', false );
</span><del>- $this->assertFalse( bp_activity_get_meta( $a, 'foo' ) );
</del><ins>+ $this->assertSame( '', bp_activity_get_meta( $a, 'foo' ) );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -163,7 +163,7 @@
</span><span class="cx"> */
</span><span class="cx"> public function test_bp_activity_update_meta_new() {
</span><span class="cx"> $a = $this->factory->activity->create();
</span><del>- $this->assertFalse( bp_activity_get_meta( $a, 'foo' ), '"foo" meta should be empty for this activity item.' );
</del><ins>+ $this->assertSame( '', bp_activity_get_meta( $a, 'foo' ), '"foo" meta should be empty for this activity item.' );
</ins><span class="cx"> $this->assertTrue( bp_activity_update_meta( $a, 'foo', 'bar' ) );
</span><span class="cx"> $this->assertSame( 'bar', bp_activity_get_meta( $a, 'foo' ) );
</span><span class="cx"> }
</span><span class="lines">@@ -238,7 +238,7 @@
</span><span class="cx"> bp_activity_update_meta( $a, 'foo', 'bar' );
</span><span class="cx">
</span><span class="cx"> $krazy_key = ' f!@#$%^o *(){}o?+';
</span><del>- $this->assertEmpty( bp_activity_get_meta( $a, $krazy_key ) );
</del><ins>+ $this->assertSame( '', bp_activity_get_meta( $a, $krazy_key ) );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -269,12 +269,12 @@
</span><span class="cx"> /**
</span><span class="cx"> * @group bp_activity_get_meta
</span><span class="cx"> * @group activitymeta
</span><ins>+ * @ticket BP5399
</ins><span class="cx"> */
</span><span class="cx"> public function test_bp_activity_get_meta_no_results_returns_false() {
</span><span class="cx"> $a = $this->factory->activity->create();
</span><span class="cx">
</span><del>- // @todo this is a quirk
- $this->assertFalse( bp_activity_get_meta( $a, 'foo' ) );
</del><ins>+ $this->assertSame( '', bp_activity_get_meta( $a, 'foo' ) );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -346,7 +346,7 @@
</span><span class="cx"> $a = $this->factory->activity->create();
</span><span class="cx"> bp_activity_update_meta( $a, 'foo', 'bar' );
</span><span class="cx"> $this->assertTrue( bp_activity_delete_meta( $a, 'foo', 'bar' ) );
</span><del>- $this->assertFalse( bp_activity_get_meta( $a, 'foo' ) );
</del><ins>+ $this->assertSame( '', bp_activity_get_meta( $a, 'foo' ) );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -358,8 +358,8 @@
</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"> $this->assertTrue( bp_activity_delete_meta( $a ) );
</span><del>- $this->assertFalse( bp_activity_get_meta( $a, 'foo' ) );
- $this->assertFalse( bp_activity_get_meta( $a, 'foo1' ) );
</del><ins>+ $this->assertSame( '', bp_activity_get_meta( $a, 'foo' ) );
+ $this->assertSame( '', bp_activity_get_meta( $a, 'foo1' ) );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -370,7 +370,7 @@
</span><span class="cx"> $a = $this->factory->activity->create();
</span><span class="cx"> bp_activity_update_meta( $a, 'foo', 'bar' );
</span><span class="cx"> $this->assertTrue( bp_activity_delete_meta( $a, 'foo', 'bar' ) );
</span><del>- $this->assertFalse( bp_activity_get_meta( $a, 'foo' ) );
</del><ins>+ $this->assertSame( '', bp_activity_get_meta( $a, 'foo' ) );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -408,8 +408,8 @@
</span><span class="cx"> bp_activity_update_meta( $a2, 'foo1', 'bar1' );
</span><span class="cx">
</span><span class="cx"> $this->assertTrue( bp_activity_delete_meta( $a1, 'foo', '', true ) );
</span><del>- $this->assertEmpty( '', bp_activity_get_meta( $a1, 'foo' ) );
- $this->assertEmpty( '', bp_activity_get_meta( $a2, 'foo' ) );
</del><ins>+ $this->assertSame( '', bp_activity_get_meta( $a1, 'foo' ) );
+ $this->assertSame( '', bp_activity_get_meta( $a2, 'foo' ) );
</ins><span class="cx"> $this->assertSame( 'bar1', bp_activity_get_meta( $a1, 'foo1' ) );
</span><span class="cx"> $this->assertSame( 'bar1', bp_activity_get_meta( $a2, 'foo1' ) );
</span><span class="cx"> }
</span></span></pre></div>
<a id="trunkteststestcasesblogsfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/tests/testcases/blogs/functions.php (8130 => 8131)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/testcases/blogs/functions.php 2014-03-14 00:15:41 UTC (rev 8130)
+++ trunk/tests/testcases/blogs/functions.php 2014-03-14 00:37:28 UTC (rev 8131)
</span><span class="lines">@@ -93,8 +93,8 @@
</span><span class="cx"> bp_blogs_add_blogmeta( 2, 'foo1', 'bar1' );
</span><span class="cx">
</span><span class="cx"> $this->assertTrue( bp_blogs_delete_blogmeta( 1, 'foo', '', true ) );
</span><del>- $this->assertEmpty( '', bp_blogs_get_blogmeta( 1, 'foo' ) );
- $this->assertEmpty( '', bp_blogs_get_blogmeta( 2, 'foo' ) );
</del><ins>+ $this->assertSame( '', bp_blogs_get_blogmeta( 1, 'foo' ) );
+ $this->assertSame( '', bp_blogs_get_blogmeta( 2, 'foo' ) );
</ins><span class="cx"> $this->assertSame( 'bar1', bp_blogs_get_blogmeta( 1, 'foo1' ) );
</span><span class="cx"> $this->assertSame( 'bar1', bp_blogs_get_blogmeta( 2, 'foo1' ) );
</span><span class="cx"> }
</span><span class="lines">@@ -116,7 +116,7 @@
</span><span class="cx"> public function test_bp_blogs_get_blogmeta_illegal_characters() {
</span><span class="cx"> bp_blogs_update_blogmeta( 1, 'foo', 'bar' );
</span><span class="cx"> $krazy_key = ' f!@#$%^o *(){}o?+';
</span><del>- $this->assertEmpty( bp_blogs_get_blogmeta( 1, $krazy_key ) );
</del><ins>+ $this->assertSame( '', bp_blogs_get_blogmeta( 1, $krazy_key ) );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -174,7 +174,7 @@
</span><span class="cx"> public function test_bp_blogs_update_blogmeta_illegal_characters() {
</span><span class="cx"> $krazy_key = ' f!@#$%^o *(){}o?+';
</span><span class="cx"> bp_blogs_update_blogmeta( 1, $krazy_key, 'bar' );
</span><del>- $this->assertEmpty( bp_blogs_get_blogmeta( 1, 'foo' ) );
</del><ins>+ $this->assertSame( '', bp_blogs_get_blogmeta( 1, 'foo' ) );
</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 (8130 => 8131)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/testcases/groups/functions.php 2014-03-14 00:15:41 UTC (rev 8130)
+++ trunk/tests/testcases/groups/functions.php 2014-03-14 00:37:28 UTC (rev 8131)
</span><span class="lines">@@ -307,7 +307,7 @@
</span><span class="cx"> */
</span><span class="cx"> public function test_groups_update_groupmeta_new() {
</span><span class="cx"> $g = $this->factory->group->create();
</span><del>- $this->assertEquals( '', groups_get_groupmeta( $g, 'foo' ), '"foo" meta should be empty for this group.' );
</del><ins>+ $this->assertSame( '', groups_get_groupmeta( $g, 'foo' ), '"foo" meta should be empty for this group.' );
</ins><span class="cx"> $this->assertTrue( groups_update_groupmeta( $g, 'foo', 'bar' ) );
</span><span class="cx"> $this->assertSame( 'bar', groups_get_groupmeta( $g, 'foo' ) );
</span><span class="cx"> }
</span><span class="lines">@@ -364,7 +364,7 @@
</span><span class="cx"> groups_update_groupmeta( $g, 'foo', 'bar' );
</span><span class="cx">
</span><span class="cx"> $krazy_key = ' f!@#$%^o *(){}o?+';
</span><del>- $this->assertEmpty( groups_get_groupmeta( $g, $krazy_key ) );
</del><ins>+ $this->assertSame( '', groups_get_groupmeta( $g, $krazy_key ) );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -508,8 +508,8 @@
</span><span class="cx"> groups_add_groupmeta( $g2, 'foo1', 'bar1' );
</span><span class="cx">
</span><span class="cx"> $this->assertTrue( groups_delete_groupmeta( $g1, 'foo', '', true ) );
</span><del>- $this->assertEmpty( '', groups_get_groupmeta( $g1, 'foo' ) );
- $this->assertEmpty( '', groups_get_groupmeta( $g2, 'foo' ) );
</del><ins>+ $this->assertSame( '', groups_get_groupmeta( $g1, 'foo' ) );
+ $this->assertSame( '', groups_get_groupmeta( $g2, 'foo' ) );
</ins><span class="cx"> $this->assertSame( 'bar1', groups_get_groupmeta( $g1, 'foo1' ) );
</span><span class="cx"> $this->assertSame( 'bar1', groups_get_groupmeta( $g2, 'foo1' ) );
</span><span class="cx"> }
</span></span></pre></div>
<a id="trunkteststestcasesxprofilefunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/tests/testcases/xprofile/functions.php (8130 => 8131)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/testcases/xprofile/functions.php 2014-03-14 00:15:41 UTC (rev 8130)
+++ trunk/tests/testcases/xprofile/functions.php 2014-03-14 00:37:28 UTC (rev 8131)
</span><span class="lines">@@ -220,7 +220,7 @@
</span><span class="cx"> bp_xprofile_update_meta( $g, 'group', 'foo', 'bar' );
</span><span class="cx"> $this->assertSame( 'bar', bp_xprofile_get_meta( $g, 'group', 'foo' ) );
</span><span class="cx"> $this->assertTrue( bp_xprofile_delete_meta( $g, 'group', 'foo', 'bar' ) );
</span><del>- $this->assertEquals( '', bp_xprofile_get_meta( $g, 'group', 'foo' ) );
</del><ins>+ $this->assertSame( '', bp_xprofile_get_meta( $g, 'group', 'foo' ) );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -236,8 +236,8 @@
</span><span class="cx">
</span><span class="cx"> $this->assertTrue( bp_xprofile_delete_meta( $g, 'group' ) );
</span><span class="cx">
</span><del>- $this->assertEquals( '', bp_xprofile_get_meta( $g, 'group', 'foo' ) );
- $this->assertEquals( '', bp_xprofile_get_meta( $g, 'group', 'foo2' ) );
</del><ins>+ $this->assertSame( '', bp_xprofile_get_meta( $g, 'group', 'foo' ) );
+ $this->assertSame( '', bp_xprofile_get_meta( $g, 'group', 'foo2' ) );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -275,8 +275,8 @@
</span><span class="cx"> bp_xprofile_add_meta( $g2, 'group', 'foo1', 'bar1' );
</span><span class="cx">
</span><span class="cx"> $this->assertTrue( bp_xprofile_delete_meta( $g1, 'group', 'foo', '', true ) );
</span><del>- $this->assertEmpty( '', bp_xprofile_get_meta( $g1, 'group', 'foo' ) );
- $this->assertEmpty( '', bp_xprofile_get_meta( $g2, 'group', 'foo' ) );
</del><ins>+ $this->assertSame( '', bp_xprofile_get_meta( $g1, 'group', 'foo' ) );
+ $this->assertSame( '', bp_xprofile_get_meta( $g2, 'group', 'foo' ) );
</ins><span class="cx"> $this->assertSame( 'bar1', bp_xprofile_get_meta( $g1, 'group', 'foo1' ) );
</span><span class="cx"> $this->assertSame( 'bar1', bp_xprofile_get_meta( $g2, 'group', 'foo1' ) );
</span><span class="cx"> }
</span><span class="lines">@@ -385,7 +385,7 @@
</span><span class="cx"> $g = $this->factory->xprofile_group->create();
</span><span class="cx"> $krazy_key = ' f!@#$%^o *(){}o?+';
</span><span class="cx"> bp_xprofile_update_meta( $g, 'group', $krazy_key, 'bar' );
</span><del>- $this->assertEmpty( bp_xprofile_get_meta( $g, 'group', 'foo' ) );
</del><ins>+ $this->assertSame( '', bp_xprofile_get_meta( $g, 'group', 'foo' ) );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span></span></pre>
</div>
</div>
</body>
</html>