Changeset 10163 for trunk/src/bp-xprofile/bp-xprofile-caps.php

Timestamp:

10/01/2015 04:18:13 AM (10 years ago)

Author:

tw2113

Message:

First pass of documentation cleanup for the XProfile Component.

See #6406.

File:

• trunk/src/bp-xprofile/bp-xprofile-caps.php (modified) (2 diffs)

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

@@ -12 +12 @@
 
 /**
- * Maps XProfile caps to built in WordPress caps
+ * Maps XProfile caps to built in WordPress caps.
  *
  * @since 1.6.0
  *
- * @param array $caps Capabilities for meta capability
- * @param string $cap Capability name
- * @param int $user_id User id
- * @param mixed $args Arguments
- * @uses get_post() To get the post
- * @uses get_post_type_object() To get the post type object
- * @uses apply_filters() Calls 'bp_map_meta_caps' with caps, cap, user id and
- *                        args
- * @return array Actual capabilities for meta capability
+ * @param array  $caps    Capabilities for meta capability.
+ * @param string $cap     Capability name.
+ * @param int    $user_id User id.
+ * @param mixed  $args    Arguments.
+ *
+ * @uses get_post() To get the post.
+ * @uses get_post_type_object() To get the post type object.
+ * @uses apply_filters() Calls 'bp_map_meta_caps' with caps, cap, user id and args.
+ *
+ * @return array Actual capabilities for meta capability.
  */
 function bp_xprofile_map_meta_caps( $caps, $cap, $user_id, $args ) {
     switch ( $cap ) {
         case 'bp_xprofile_change_field_visibility' :
-            $caps = array( 'exist' ); // Must allow for logged-out users during registration
+            $caps = array( 'exist' ); // Must allow for logged-out users during registration.
 
-            // You may pass args manually: $field_id, $profile_user_id
+            // You may pass args manually: $field_id, $profile_user_id.
             $field_id        = isset( $args[0] ) ? (int)$args[0] : bp_get_the_profile_field_id();
             $profile_user_id = isset( $args[1] ) ? (int)$args[1] : bp_displayed_user_id();
 
-            // Visibility on the fullname field is not editable
+            // Visibility on the fullname field is not editable.
             if ( 1 == $field_id ) {
                 $caps[] = 'do_not_allow';
@@ -47 +48 @@
             }
 
-            // Friends don't let friends edit each other's visibility
+            // Friends don't let friends edit each other's visibility.
             if ( $profile_user_id != bp_displayed_user_id() && !bp_current_user_can( 'bp_moderate' ) ) {
                 $caps[] = 'do_not_allow';