Changeset 10253 for trunk/src/bp-activity/bp-activity-screens.php

Timestamp:

10/12/2015 05:45:14 AM (10 years ago)

Author:

tw2113

Message:

Further documentation cleanup for Activity Component.

See #6396.

File:

• trunk/src/bp-activity/bp-activity-screens.php (modified) (12 diffs)

trunk/src/bp-activity/bp-activity-screens.php

@@ -11 +11 @@
  */
 
-// Exit if accessed directly
+// Exit if accessed directly.
 defined( 'ABSPATH' ) || exit;
 
@@ -253 +253 @@
     $bp = buddypress();
 
-    // No displayed user or not viewing activity component
+    // No displayed user or not viewing activity component.
     if ( !bp_is_activity_component() )
         return false;
@@ -260 +260 @@
         return false;
 
-    // Get the activity details
+    // Get the activity details.
     $activity = bp_activity_get_specific( array( 'activity_ids' => bp_current_action(), 'show_hidden' => true, 'spam' => 'ham_only', ) );
 
@@ -272 +272 @@
     }
 
-    // Default access is true
+    // Default access is true.
     $has_access = true;
 
-    // If activity is from a group, do an extra cap check
+    // If activity is from a group, do an extra cap check.
     if ( isset( $bp->groups->id ) && $activity->component == $bp->groups->id ) {
 
-        // Activity is from a group, but groups is currently disabled
+        // Activity is from a group, but groups is currently disabled.
         if ( !bp_is_active( 'groups') ) {
             bp_do_404();
@@ -285 +285 @@
 
         // Check to see if the group is not public, if so, check the
-        // user has access to see this activity
+        // user has access to see this activity.
         if ( $group = groups_get_group( array( 'group_id' => $activity->item_id ) ) ) {
 
-            // Group is not public
+            // Group is not public.
             if ( 'public' != $group->status ) {
 
-                // User is not a member of group
+                // User is not a member of group.
                 if ( !groups_is_user_member( bp_loggedin_user_id(), $group->id ) ) {
                     $has_access = false;
@@ -318 +318 @@
     do_action( 'bp_activity_screen_single_activity_permalink', $activity, $has_access );
 
-    // Access is specifically disallowed
+    // Access is specifically disallowed.
     if ( false === $has_access ) {
 
-        // User feedback
+        // User feedback.
         bp_core_add_message( __( 'You do not have access to this activity.', 'buddypress' ), 'error' );
 
-        // Redirect based on logged in status
+        // Redirect based on logged in status.
         if ( is_user_logged_in() ) {
             $url = bp_loggedin_user_domain();
@@ -442 +442 @@
     public function is_activity() {
 
-        // Bail if not looking at a group
+        // Bail if not looking at a group.
         if ( ! bp_is_activity_component() )
             return;
 
-        // Activity Directory
+        // Activity Directory.
         if ( ! bp_displayed_user_id() && ! bp_current_action() ) {
             bp_update_is_directory( true, 'activity' );
@@ -457 +457 @@
             add_filter( 'bp_replace_the_content',                    array( $this, 'directory_content'    ) );
 
-        // Single activity
+        // Single activity.
         } elseif ( bp_is_single_activity() ) {
             add_filter( 'bp_get_buddypress_template',                array( $this, 'single_template_hierarchy' ) );
@@ -475 +475 @@
      *
      * @param string $templates The templates from bp_get_theme_compat_templates().
-     *
      * @return array $templates Array of custom templates to look for.
      */
@@ -492 +491 @@
 
         // Merge new templates with existing stack
-        // @see bp_get_theme_compat_templates()
+        // @see bp_get_theme_compat_templates().
         $templates = array_merge( (array) $new_templates, $templates );
 
@@ -536 +535 @@
      *
      * @param string $templates The templates from bp_get_theme_compat_templates().
-     *
      * @return array $templates Array of custom templates to look for.
      */
@@ -553 +551 @@
 
         // Merge new templates with existing stack
-        // @see bp_get_theme_compat_templates()
+        // @see bp_get_theme_compat_templates().
         $templates = array_merge( (array) $new_templates, $templates );