<!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][8157] trunk/bp-groups: Improve validation and documentation for groups_create_group() and BP_Groups_Group::save()</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/8157">8157</a></dd>
<dt>Author</dt> <dd>boonebgorges</dd>
<dt>Date</dt> <dd>2014-03-25 18:30:56 +0000 (Tue, 25 Mar 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Improve validation and documentation for groups_create_group() and BP_Groups_Group::save()
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/5214">#5214</a>
Props r-a-y</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpgroupsbpgroupsclassesphp">trunk/bp-groups/bp-groups-classes.php</a></li>
<li><a href="#trunkbpgroupsbpgroupsfunctionsphp">trunk/bp-groups/bp-groups-functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpgroupsbpgroupsclassesphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-groups/bp-groups-classes.php (8156 => 8157)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-groups/bp-groups-classes.php 2014-03-25 18:15:09 UTC (rev 8156)
+++ trunk/bp-groups/bp-groups-classes.php 2014-03-25 18:30:56 UTC (rev 8157)
</span><span class="lines">@@ -265,6 +265,26 @@
</span><span class="cx">
</span><span class="cx"> do_action_ref_array( 'groups_group_before_save', array( &$this ) );
</span><span class="cx">
</span><ins>+ // Groups need at least a name
+ if ( empty( $this->name ) ) {
+ return false;
+ }
+
+ // Set slug with group title if not passed
+ if ( empty( $this->slug ) ) {
+ $this->slug = sanitize_title( $this->name );
+ }
+
+ // Sanity check
+ if ( empty( $this->slug ) ) {
+ return false;
+ }
+
+ // Check for slug conflicts if creating new group
+ if ( empty( $this->id ) ) {
+ $this->slug = groups_check_slug( $this->slug );
+ }
+
</ins><span class="cx"> if ( !empty( $this->id ) ) {
</span><span class="cx"> $sql = $wpdb->prepare(
</span><span class="cx"> "UPDATE {$bp->groups->table_name} SET
</span></span></pre></div>
<a id="trunkbpgroupsbpgroupsfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-groups/bp-groups-functions.php (8156 => 8157)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-groups/bp-groups-functions.php 2014-03-25 18:15:09 UTC (rev 8156)
+++ trunk/bp-groups/bp-groups-functions.php 2014-03-25 18:30:56 UTC (rev 8157)
</span><span class="lines">@@ -57,57 +57,86 @@
</span><span class="cx">
</span><span class="cx"> /*** Group Creation, Editing & Deletion *****************************************/
</span><span class="cx">
</span><ins>+/**
+ * Create a group.
+ *
+ * @since BuddyPress (1.0.0)
+ *
+ * @param array $args {
+ * An array of arguments.
+ * @type int|bool $group_id Pass a group ID to update an existing item, or
+ * 0 / false to create a new group. Default: 0.
+ * @type int $creator_id The user ID that creates the group.
+ * @type string $name The group name.
+ * @type string $description Optional. The group's description.
+ * @type string $slug The group slug.
+ * @type string $status The group's status. Accepts 'public', 'private' or
+ 'hidden'. Defaults to 'public'.
+ * @type int $enable_forum Optional. Whether the group has a forum enabled.
+ * If the legacy forums are enabled for this group or if a bbPress
+ * forum is enabled for the group, set this to 1. Default: 0.
+ * @type string $date_created The GMT time, in Y-m-d h:i:s format,
+ * when the group was created. Defaults to the current time.
+ * }
+ * @return int|bool The ID of the group on success. False on error.
+ */
</ins><span class="cx"> function groups_create_group( $args = '' ) {
</span><span class="cx">
</span><del>- extract( $args );
</del><ins>+ $defaults = array(
+ 'group_id' => 0,
+ 'creator_id' => 0,
+ 'name' => '',
+ 'description' => '',
+ 'slug' => '',
+ 'status' => 'public',
+ 'enable_forum' => 0,
+ 'date_created' => bp_core_current_time()
+ );
</ins><span class="cx">
</span><del>- /**
- * Possible parameters (pass as assoc array):
- * 'group_id'
- * 'creator_id'
- * 'name'
- * 'description'
- * 'slug'
- * 'status'
- * 'enable_forum'
- * 'date_created'
- */
</del><ins>+ $args = wp_parse_args( $args, $defaults );
+ extract( $args, EXTR_SKIP );
</ins><span class="cx">
</span><del>- if ( !empty( $group_id ) )
- $group = groups_get_group( array( 'group_id' => $group_id ) );
- else
</del><ins>+ // Pass an existing group ID
+ if ( ! empty( $group_id ) ) {
+ $group = groups_get_group( array( 'group_id' => (int) $group_id ) );
+ $name = ! empty( $name ) ? $name : $group->name;
+ $slug = ! empty( $slug ) ? $slug : $group->slug;
+
+ // Groups need at least a name
+ if ( empty( $name ) ) {
+ return false;
+ }
+
+ // Create a new group
+ } else {
+ // Instantiate new group object
</ins><span class="cx"> $group = new BP_Groups_Group;
</span><ins>+ }
</ins><span class="cx">
</span><del>- if ( !empty( $creator_id ) )
- $group->creator_id = $creator_id;
- else
</del><ins>+ // Set creator ID
+ if ( ! empty( $creator_id ) ) {
+ $group->creator_id = (int) $creator_id;
+ } else {
</ins><span class="cx"> $group->creator_id = bp_loggedin_user_id();
</span><ins>+ }
</ins><span class="cx">
</span><del>- if ( isset( $name ) )
- $group->name = $name;
-
- if ( isset( $description ) )
- $group->description = $description;
-
- if ( isset( $slug ) && groups_check_slug( $slug ) )
- $group->slug = $slug;
-
- if ( isset( $status ) ) {
- if ( groups_is_valid_status( $status ) ) {
- $group->status = $status;
- }
</del><ins>+ // Validate status
+ if ( ! groups_is_valid_status( $status ) ) {
+ return false;
</ins><span class="cx"> }
</span><span class="cx">
</span><del>- if ( isset( $enable_forum ) )
- $group->enable_forum = $enable_forum;
- else if ( empty( $group_id ) && !isset( $enable_forum ) )
- $group->enable_forum = 1;
</del><ins>+ // Set group name
+ $group->name = $name;
+ $group->description = $description;
+ $group->slug = $slug;
+ $group->status = $status;
+ $group->enable_forum = (int) $enable_forum;
+ $group->date_created = $date_created;
</ins><span class="cx">
</span><del>- if ( isset( $date_created ) )
- $group->date_created = $date_created;
-
- if ( !$group->save() )
</del><ins>+ // Save group
+ if ( ! $group->save() ) {
</ins><span class="cx"> return false;
</span><ins>+ }
</ins><span class="cx">
</span><span class="cx"> // If this is a new group, set up the creator as the first member and admin
</span><span class="cx"> if ( empty( $group_id ) ) {
</span></span></pre>
</div>
</div>
</body>
</html>