Changeset 10373 for trunk/src/bp-groups/bp-groups-actions.php

Timestamp:

11/22/2015 04:58:34 AM (9 years ago)

Author:

tw2113

Message:

More docs cleanup for BP-Groups component.

See #6401.

File:

• trunk/src/bp-groups/bp-groups-actions.php (modified) (19 diffs)

trunk/src/bp-groups/bp-groups-actions.php

@@ -29 +29 @@
 
     if ( ! $user_has_access && 'hidden' !== $current_group->status ) {
-        // Always allow access to home and request-membership
+        // Always allow access to home and request-membership.
         if ( bp_is_current_action( 'home' ) || bp_is_current_action( 'request-membership' ) ) {
             $user_has_access = true;
 
-        // User doesn't have access, so set up redirect args
+        // User doesn't have access, so set up redirect args.
         } elseif ( is_user_logged_in() ) {
             $no_access_args = array(
@@ -43 +43 @@
     }
 
-    // Protect the admin tab from non-admins
+    // Protect the admin tab from non-admins.
     if ( bp_is_current_action( 'admin' ) && ! bp_is_item_admin() ) {
         $user_has_access = false;
@@ -95 +95 @@
 function groups_action_create_group() {
 
-    // If we're not at domain.org/groups/create/ then return false
+    // If we're not at domain.org/groups/create/ then return false.
     if ( !bp_is_groups_component() || !bp_is_current_action( 'create' ) )
         return false;
@@ -109 +109 @@
     $bp = buddypress();
 
-    // Make sure creation steps are in the right order
+    // Make sure creation steps are in the right order.
     groups_action_sort_creation_steps();
 
-    // If no current step is set, reset everything so we can start a fresh group creation
+    // If no current step is set, reset everything so we can start a fresh group creation.
     $bp->groups->current_create_step = bp_action_variable( 1 );
     if ( !bp_get_groups_current_create_step() ) {
@@ -126 +126 @@
     }
 
-    // If this is a creation step that is not recognized, just redirect them back to the first screen
+    // If this is a creation step that is not recognized, just redirect them back to the first screen.
     if ( bp_get_groups_current_create_step() && empty( $bp->groups->group_creation_steps[bp_get_groups_current_create_step()] ) ) {
         bp_core_add_message( __('There was an error saving group details. Please try again.', 'buddypress'), 'error' );
@@ -132 +132 @@
     }
 
-    // Fetch the currently completed steps variable
+    // Fetch the currently completed steps variable.
     if ( isset( $_COOKIE['bp_completed_create_steps'] ) && !isset( $reset_steps ) )
         $bp->groups->completed_create_steps = json_decode( base64_decode( stripslashes( $_COOKIE['bp_completed_create_steps'] ) ) );
 
-    // Set the ID of the new group, if it has already been created in a previous step
+    // Set the ID of the new group, if it has already been created in a previous step.
     if ( isset( $_COOKIE['bp_new_group_id'] ) ) {
         $bp->groups->new_group_id = (int) $_COOKIE['bp_new_group_id'];
         $bp->groups->current_group = groups_get_group( array( 'group_id' => $bp->groups->new_group_id ) );
 
-        // Only allow the group creator to continue to edit the new group
+        // Only allow the group creator to continue to edit the new group.
         if ( ! bp_is_group_creator( $bp->groups->current_group, bp_loggedin_user_id() ) ) {
             bp_core_add_message( __( 'Only the group creator may continue editing this group.', 'buddypress' ), 'error' );
@@ -148 +148 @@
     }
 
-    // If the save, upload or skip button is hit, lets calculate what we need to save
+    // If the save, upload or skip button is hit, lets calculate what we need to save.
     if ( isset( $_POST['save'] ) ) {
 
-        // Check the nonce
+        // Check the nonce.
         check_admin_referer( 'groups_create_save_' . bp_get_groups_current_create_step() );
 
@@ -175 +175 @@
                 $group_enable_forum = 0;
             } else {
-                // Create the forum if enable_forum = 1
+                // Create the forum if enable_forum = 1.
                 if ( bp_is_active( 'forums' ) && !groups_get_groupmeta( $bp->groups->new_group_id, 'forum_id' ) ) {
                     groups_new_group_forum();
@@ -247 +247 @@
             $bp->groups->completed_create_steps[] = bp_get_groups_current_create_step();
 
-        // Reset cookie info
+        // Reset cookie info.
         setcookie( 'bp_new_group_id', $bp->groups->new_group_id, time()+60*60*24, COOKIEPATH );
         setcookie( 'bp_completed_create_steps', base64_encode( json_encode( $bp->groups->completed_create_steps ) ), time()+60*60*24, COOKIEPATH );
 
         // If we have completed all steps and hit done on the final step we
-        // can redirect to the completed group
+        // can redirect to the completed group.
         $keys = array_keys( $bp->groups->group_creation_steps );
         if ( count( $bp->groups->completed_create_steps ) == count( $keys ) && bp_get_groups_current_create_step() == array_pop( $keys ) ) {
@@ -298 +298 @@
     }
 
-    // Remove invitations
+    // Remove invitations.
     if ( 'group-invites' === bp_get_groups_current_create_step() && ! empty( $_REQUEST['user_id'] ) && is_numeric( $_REQUEST['user_id'] ) ) {
         if ( ! check_admin_referer( 'groups_invite_uninvite_user' ) ) {
@@ -316 +316 @@
     }
 
-    // Group avatar is handled separately
+    // Group avatar is handled separately.
     if ( 'group-avatar' == bp_get_groups_current_create_step() && isset( $_POST['upload'] ) ) {
         if ( ! isset( $bp->avatar_admin ) ) {
@@ -323 +323 @@
 
         if ( !empty( $_FILES ) && isset( $_POST['upload'] ) ) {
-            // Normally we would check a nonce here, but the group save nonce is used instead
-
-            // Pass the file to the avatar upload handler
+            // Normally we would check a nonce here, but the group save nonce is used instead.
+            // Pass the file to the avatar upload handler.
             if ( bp_core_avatar_handle_upload( $_FILES, 'groups_avatar_upload_dir' ) ) {
                 $bp->avatar_admin->step = 'crop-image';
 
-                // Make sure we include the jQuery jCrop file for image cropping
+                // Make sure we include the jQuery jCrop file for image cropping.
                 add_action( 'wp_print_scripts', 'bp_core_add_jquery_cropper' );
             }
         }
 
-        // If the image cropping is done, crop the image and save a full/thumb version
+        // If the image cropping is done, crop the image and save a full/thumb version.
         if ( isset( $_POST['avatar-crop-submit'] ) && isset( $_POST['upload'] ) ) {
-            // Normally we would check a nonce here, but the group save nonce is used instead
-
+            // Normally we would check a nonce here, but the group save nonce is used instead.
             if ( !bp_core_avatar_handle_crop( array( 'object' => 'group', 'avatar_dir' => 'group-avatars', 'item_id' => $bp->groups->current_group->id, 'original_file' => $_POST['image_src'], 'crop_x' => $_POST['x'], 'crop_y' => $_POST['y'], 'crop_w' => $_POST['w'], 'crop_h' => $_POST['h'] ) ) )
                 bp_core_add_message( __( 'There was an error saving the group profile photo, please try uploading again.', 'buddypress' ), 'error' );
@@ -364 +362 @@
         return false;
 
-    // Nonce check
+    // Nonce check.
     if ( !check_admin_referer( 'groups_join_group' ) )
         return false;
@@ -370 +368 @@
     $bp = buddypress();
 
-    // Skip if banned or already a member
+    // Skip if banned or already a member.
     if ( !groups_is_user_member( bp_loggedin_user_id(), $bp->groups->current_group->id ) && !groups_is_user_banned( bp_loggedin_user_id(), $bp->groups->current_group->id ) ) {
 
-        // User wants to join a group that is not public
+        // User wants to join a group that is not public.
         if ( $bp->groups->current_group->status != 'public' ) {
             if ( !groups_check_user_has_invite( bp_loggedin_user_id(), $bp->groups->current_group->id ) ) {
@@ -381 +379 @@
         }
 
-        // User wants to join any group
+        // User wants to join any group.
         if ( !groups_join_group( $bp->groups->current_group->id ) )
             bp_core_add_message( __( 'There was an error joining the group.', 'buddypress' ), 'error' );
@@ -417 +415 @@
     }
 
-    // Nonce check
+    // Nonce check.
     if ( ! check_admin_referer( 'groups_leave_group' ) ) {
         return false;
     }
 
-    // User wants to leave any group
+    // User wants to leave any group.
     if ( groups_is_user_member( bp_loggedin_user_id(), bp_get_current_group_id() ) ) {
         $bp = buddypress();
 
-        // Stop sole admins from abandoning their group
+        // Stop sole admins from abandoning their group.
         $group_admins = groups_get_group_admins( bp_get_current_group_id() );
 
@@ -473 +471 @@
     }
 
-    // Sort the steps by their position key
+    // Sort the steps by their position key.
     ksort($temp);
     unset($bp->groups->group_creation_steps);
@@ -510 +508 @@
 function groups_action_group_feed() {
 
-    // get current group
+    // Get current group.
     $group = groups_get_current_group();
 
@@ -516 +514 @@
         return false;
 
-    // if group isn't public or if logged-in user is not a member of the group, do
-    // not output the group activity feed
+    // If group isn't public or if logged-in user is not a member of the group, do
+    // not output the group activity feed.
     if ( ! bp_group_is_visible( $group ) ) {
         return false;
     }
 
-    // setup the feed
+    // Set up the feed.
     buddypress()->activity->feed = new BP_Activity_Feed( array(
         'id'            => 'group',