Changeset 10356 for trunk/src/bp-core/bp-core-caps.php

Timestamp:

11/15/2015 07:57:03 PM (10 years ago)

Author:

tw2113

Message:

[Samus Aran]
I first battled the documentation inconsistencies on planet Zebes. It was there that I foiled the plans of the
Space Pirate leader Mother Brain to use the issues to attack galactic civilization...

I next fought the inconsistencies on their homeworld SR388. I completely eradicated them except for an @since tag,
which after hatching followed me like a confused child...

I personally delivered it to the Galactic Research Station at Ceres so scientists could study its energy production qualities...

The scientists' findings were astounding! They discovered that the powers of the docs inconsistencies
might be harnessed for the good of galactic civilization!

Satisfied that all was well, I left the station to seek a new bounty to hunt. But, I had hardly gone beyond the asteroid
belt when I picked up a distress signal!

Ceres station was under attack!

More documentation cleanup for part of BP-Core component.

See #6398.

File:

• trunk/src/bp-core/bp-core-caps.php (modified) (12 diffs)

trunk/src/bp-core/bp-core-caps.php

@@ -25 +25 @@
     global $wp_roles;
 
-    // Sanity check on roles global variable
+    // Sanity check on roles global variable.
     $roles = isset( $wp_roles->roles )
         ? $wp_roles->roles
@@ -64 +64 @@
     global $wp_roles;
 
-    // Load roles if not set
+    // Load roles if not set.
     if ( ! isset( $wp_roles ) ) {
         $wp_roles = new WP_Roles();
     }
 
-    // Loop through available roles and add them
+    // Loop through available roles and add them.
     foreach( $wp_roles->role_objects as $role ) {
         foreach ( bp_get_caps_for_role( $role->name ) as $cap ) {
@@ -100 +100 @@
     global $wp_roles;
 
-    // Load roles if not set
+    // Load roles if not set.
     if ( ! isset( $wp_roles ) ) {
         $wp_roles = new WP_Roles();
     }
 
-    // Loop through available roles and remove them
+    // Loop through available roles and remove them.
     foreach( $wp_roles->role_objects as $role ) {
         foreach ( bp_get_caps_for_role( $role->name ) as $cap ) {
@@ -136 +136 @@
  * @param int    $user_id See {@link WP_User::has_cap()}.
  * @param mixed  $args    See {@link WP_User::has_cap()}.
- *
  * @return array Actual capabilities for meta capability. See {@link WP_User::has_cap()}.
  */
@@ -165 +164 @@
 function bp_get_community_caps() {
 
-    // Forum meta caps
+    // Forum meta caps.
     $caps = array();
 
@@ -186 +185 @@
  *
  * @param string $role The role for which you're loading caps.
- *
  * @return array Capabilities for $role.
  */
@@ -194 +192 @@
     switch ( $role ) {
 
-        // Administrator
+        // Administrator.
         case 'administrator' :
             $caps = array(
-                // Misc
+                // Misc.
                 'bp_moderate',
             );
@@ -203 +201 @@
             break;
 
-        // All other default WordPress blog roles
+        // All other default WordPress blog roles.
         case 'editor'      :
         case 'author'      :
@@ -243 +241 @@
 function bp_set_current_user_default_role() {
 
-    // Bail if not multisite or not root blog
+    // Bail if not multisite or not root blog.
     if ( ! is_multisite() || ! bp_is_root_blog() ) {
         return;
     }
 
-    // Bail if user is not logged in or already a member
+    // Bail if user is not logged in or already a member.
     if ( ! is_user_logged_in() || is_user_member_of_blog() ) {
         return;
     }
 
-    // Bail if user is not active
+    // Bail if user is not active.
     if ( bp_is_user_inactive() ) {
         return;
     }
 
-    // Set the current users default role
+    // Set the current users default role.
     buddypress()->current_user->set_role( bp_get_option( 'default_role', 'subscriber' ) );
 }
@@ -274 +272 @@
  *     @type mixed $a,...   Optional. Extra arguments applicable to the capability check.
  * }
- *
  * @return bool True if the user has the cap for the given parameters.
  */
@@ -292 +289 @@
     }
 
-    // Use root blog if no ID passed
+    // Use root blog if no ID passed.
     if ( empty( $blog_id ) ) {
         $blog_id = bp_get_root_blog_id();
@@ -341 +338 @@
  * @param int    $user_id ID of the user being checked against.
  * @param array  $args    Miscellaneous arguments passed to the user_has_cap filter.
- *
  * @return array $allcaps The user's cap list, with 'bp_moderate' appended, if relevant.
  */
 function _bp_enforce_bp_moderate_cap_for_admins( $caps = array(), $cap = '', $user_id = 0, $args = array() ) {
 
-    // Bail if not checking the 'bp_moderate' cap
+    // Bail if not checking the 'bp_moderate' cap.
     if ( 'bp_moderate' !== $cap ) {
         return $caps;
     }
 
-    // Bail if BuddyPress is not network activated
+    // Bail if BuddyPress is not network activated.
     if ( bp_is_network_activated() ) {
         return $caps;
     }
 
-    // Never trust inactive users
+    // Never trust inactive users.
     if ( bp_is_user_inactive( $user_id ) ) {
         return $caps;
     }
 
-    // Only users that can 'manage_options' on this site can 'bp_moderate'
+    // Only users that can 'manage_options' on this site can 'bp_moderate'.
     return array( 'manage_options' );
 }