<!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][11555] trunk: Change signature of groups_edit_base_group_details().</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/11555">11555</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/11555","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>dcavins</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-05-17 18:57:15 +0000 (Wed, 17 May 2017)</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'>Change signature of groups_edit_base_group_details().
?\226?\128?\162 Changes the signature of `groups_edit_base_group_details()` to accept
a single array instead of several arguments.
?\226?\128?\162 Adds the capability to update the group slug, with the old slug being
stored as a group meta item.
See <a href="http://buddypress.trac.wordpress.org/ticket/6014">#6014</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpgroupsbpgroupsfunctionsphp">trunk/src/bp-groups/bp-groups-functions.php</a></li>
<li><a href="#trunktestsphpunittestcasesgroupsactivityphp">trunk/tests/phpunit/testcases/groups/activity.php</a></li>
<li><a href="#trunktestsphpunittestcasesgroupsfunctionsphp">trunk/tests/phpunit/testcases/groups/functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpgroupsbpgroupsfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-groups/bp-groups-functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-groups/bp-groups-functions.php 2017-05-16 22:04:10 UTC (rev 11554)
+++ trunk/src/bp-groups/bp-groups-functions.php 2017-05-17 18:57:15 UTC (rev 11555)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -218,28 +218,76 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.0.0
</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 $group_id ID of the group.
- * @param string $group_name Name of the group.
- * @param string $group_desc Description of the group.
- * @param bool $notify_members Whether to send an email notification to group
- * members about changes in these details.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $args {
+ * An array of optional arguments.
+ * @type int $group_id ID of the group.
+ * @type string $name Name of the group.
+ * @type string $slug Slug of the group.
+ * @type string $description Description of the group.
+ * @type bool $notify_members Whether to send an email notification to group
+ * members about changes in these details.
+ * }
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool True on success, false on failure.
</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 groups_edit_base_group_details( $group_id, $group_name, $group_desc, $notify_members ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function groups_edit_base_group_details( $args = array() ) {
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( empty( $group_name ) || empty( $group_desc ) )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Backward compatibility with old method of passing arguments.
+ if ( ! is_array( $args ) || func_num_args() > 1 ) {
+ _deprecated_argument( __METHOD__, '2.9.0', sprintf( __( 'Arguments passed to %1$s should be in an associative array. See the inline documentation at %2$s for more details.', 'buddypress' ), __METHOD__, __FILE__ ) );
+
+ $old_args_keys = array(
+ 0 => 'group_id',
+ 1 => 'name',
+ 2 => 'description',
+ 3 => 'notify_members',
+ );
+
+ $args = bp_core_parse_args_array( $old_args_keys, func_get_args() );
+ }
+
+ $r = wp_parse_args( $args, array(
+ 'group_id' => bp_get_current_group_id(),
+ 'name' => null,
+ 'slug' => null,
+ 'description' => null,
+ 'notify_members' => false,
+ ) );
+
+ if ( ! $r['group_id'] ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $group = groups_get_group( $group_id );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $group = groups_get_group( $r['group_id'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> $old_group = clone $group;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $group->name = $group_name;
- $group->description = $group_desc;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Group name, slug and description can never be empty. Update only if provided.
+ if ( $r['name'] ) {
+ $group->name = $r['name'];
+ }
+ if ( $r['slug'] && $r['slug'] != $group->slug ) {
+ $group->slug = groups_check_slug( $r['slug'] );
+ }
+ if ( $r['description'] ) {
+ $group->description = $r['description'];
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( !$group->save() )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! $group->save() ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $notify_members ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Maybe update the "previous_slug" groupmeta.
+ if ( $group->slug != $old_group->slug ) {
+ /*
+ * If the old slug exists in this group's past, delete that entry.
+ * Recent previous_slugs are preferred when selecting the current group
+ * from an old group slug, so we want the previous slug to be
+ * saved "now" in the groupmeta table and don't need the old record.
+ */
+ groups_delete_groupmeta( $group->id, 'previous_slug', $old_group->slug );
+ groups_add_groupmeta( $group->id, 'previous_slug', $old_group->slug );
+ }
+
+ if ( $r['notify_members'] ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> groups_notification_group_updated( $group->id, $old_group );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -252,7 +300,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param BP_Groups_Group $old_group Group object, before being modified.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param bool $notify_members Whether to send an email notification to members about the change.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- do_action( 'groups_details_updated', $group->id, $old_group, $notify_members );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ do_action( 'groups_details_updated', $group->id, $old_group, $r['notify_members'] );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return true;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestcasesgroupsactivityphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/testcases/groups/activity.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/groups/activity.php 2017-05-16 22:04:10 UTC (rev 11554)
+++ trunk/tests/phpunit/testcases/groups/activity.php 2017-05-17 18:57:15 UTC (rev 11555)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -55,7 +55,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_bp_groups_format_activity_action_group_details_updated_with_no_change() {
</span><span class="cx" style="display: block; padding: 0 10px"> $group = $this->factory->group->create_and_get();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- groups_edit_base_group_details( $group->id, $group->name, $group->description, true );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ groups_edit_base_group_details( array(
+ 'group_id' => $group->id,
+ 'name' => $group->name,
+ 'slug' => $group->slug,
+ 'description' => $group->description,
+ 'notify_members' => true,
+ ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $a = bp_activity_get( array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'component' => buddypress()->groups->id,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -72,7 +78,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_bp_groups_format_activity_action_group_details_updated_with_notify_members_false() {
</span><span class="cx" style="display: block; padding: 0 10px"> $group = $this->factory->group->create_and_get();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- groups_edit_base_group_details( $group->id, 'Foo', $group->description, false );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ groups_edit_base_group_details( array(
+ 'group_id' => $group->id,
+ 'name' => 'Foo',
+ 'slug' => $group->slug,
+ 'description' => $group->description,
+ 'notify_members' => false,
+ ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $a = bp_activity_get( array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'component' => buddypress()->groups->id,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -93,7 +105,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->set_current_user( $u );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $group = $this->factory->group->create_and_get();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- groups_edit_base_group_details( $group->id, 'Foo', $group->description, true );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ groups_edit_base_group_details( array(
+ 'group_id' => $group->id,
+ 'name' => 'Foo',
+ 'slug' => $group->slug,
+ 'description' => $group->description,
+ 'notify_members' => true,
+ ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $a = bp_activity_get( array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'component' => buddypress()->groups->id,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -119,7 +137,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->set_current_user( $u );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $group = $this->factory->group->create_and_get();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- groups_edit_base_group_details( $group->id, $group->name, 'Bar', true );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ groups_edit_base_group_details( array(
+ 'group_id' => $group->id,
+ 'name' => $group->name,
+ 'slug' => $group->slug,
+ 'description' => 'Bar',
+ 'notify_members' => true,
+ ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $a = bp_activity_get( array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'component' => buddypress()->groups->id,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -145,7 +169,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->set_current_user( $u );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $group = $this->factory->group->create_and_get();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- groups_edit_base_group_details( $group->id, 'Foo', 'Bar', true );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ groups_edit_base_group_details( array(
+ 'group_id' => $group->id,
+ 'name' => 'Foo',
+ 'slug' => $group->slug,
+ 'description' => 'Bar',
+ 'notify_members' => true,
+ ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $a = bp_activity_get( array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'component' => buddypress()->groups->id,
</span></span></pre></div>
<a id="trunktestsphpunittestcasesgroupsfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/testcases/groups/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/groups/functions.php 2017-05-16 22:04:10 UTC (rev 11554)
+++ trunk/tests/phpunit/testcases/groups/functions.php 2017-05-17 18:57:15 UTC (rev 11555)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -711,4 +711,118 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $g1, $group->id );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * @expectedDeprecated groups_edit_base_group_details
+ * @group groups_edit_base_group_details
+ */
+ public function test_groups_edit_base_group_details_test_backcompat_arguments() {
+ $g1 = $this->factory->group->create();
+ $name = 'Great Scott';
+ $description = 'A must-see in time for the holidays!';
+ groups_edit_base_group_details( $g1, $name, $description, false );
+
+ $expected = array(
+ 'id' => $g1,
+ 'name' => $name,
+ 'description' => $description
+ );
+ $updated_group_object = groups_get_group( $g1 );
+ $updated = array(
+ 'id' => $updated_group_object->id,
+ 'name' => $updated_group_object->name,
+ 'description' => $updated_group_object->description
+ );
+
+ $this->assertEqualSets( $expected, $updated );
+ }
+
+ /**
+ * @group groups_edit_base_group_details
+ */
+ public function test_groups_edit_base_group_details_test_new_arguments() {
+ $g1 = $this->factory->group->create();
+ $name = 'Great Scott';
+ $slug = 'what-about-it';
+ $description = 'A must-see in time for the holidays!';
+ groups_edit_base_group_details( array(
+ 'group_id' => $g1,
+ 'name' => $name,
+ 'slug' => $slug,
+ 'description' => $description,
+ 'notify_members' => false,
+ ) );
+
+ $expected = array(
+ 'id' => $g1,
+ 'slug' => $slug,
+ 'name' => $name,
+ 'description' => $description
+ );
+ $updated_group_object = groups_get_group( $g1 );
+ $updated = array(
+ 'id' => $updated_group_object->id,
+ 'slug' => $updated_group_object->slug,
+ 'name' => $updated_group_object->name,
+ 'description' => $updated_group_object->description
+ );
+
+ $this->assertEqualSets( $expected, $updated );
+ }
+
+ /**
+ * @group groups_edit_base_group_details
+ */
+ public function test_groups_edit_base_group_details_avoid_slug_collisions() {
+ $slug = 'circe';
+ $g1 = $this->factory->group->create( array( 'slug' => $slug ) );
+ $g2 = $this->factory->group->create( array( 'slug' => 'loom' ) );
+
+ // Attempt to use a duplicate slug.
+ groups_edit_base_group_details( array(
+ 'group_id' => $g2,
+ 'slug' => $slug,
+ ) );
+
+ $updated_group_object = groups_get_group( $g2 );
+
+ $this->assertNotEquals( $slug, $updated_group_object->slug );
+ }
+
+ /**
+ * @group groups_edit_base_group_details
+ */
+ public function test_groups_edit_base_group_details_slug_no_change() {
+ $slug = 'circe';
+ $g1 = $this->factory->group->create( array( 'slug' => $slug ) );
+
+ // Make sure the slug doesn't get incremented when there's no change.
+ groups_edit_base_group_details( array(
+ 'group_id' => $g1,
+ 'slug' => $slug,
+ ) );
+
+ $updated_group_object = groups_get_group( $g1 );
+
+ $this->assertEquals( $slug, $updated_group_object->slug );
+ }
+
+ /**
+ * @group groups_edit_base_group_details
+ */
+ public function test_groups_edit_base_group_details_slug_null_value() {
+ $slug = 'circe';
+ $g1 = $this->factory->group->create( array( 'slug' => $slug ) );
+
+ // Make sure the slug doesn't get changed when null is passed.
+ groups_edit_base_group_details( array(
+ 'group_id' => $g1,
+ 'slug' => null,
+ ) );
+
+ $updated_group_object = groups_get_group( $g1 );
+
+ $this->assertEquals( $slug, $updated_group_object->slug );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>