Changeset 6438 for trunk/src/includes/users/capabilities.php

Timestamp:

05/27/2017 05:04:31 PM (6 years ago)

Author:

johnjamesjacoby

Message:

Tools: Add //Filter & return note for future discovery of missing filter documentation.

Also adjust some type-casting on filtered results.

File:

• trunk/src/includes/users/capabilities.php (modified) (10 diffs)

trunk/src/includes/users/capabilities.php

@@ -118 +118 @@
     }
 
-    return apply_filters( 'bbp_map_primary_meta_caps', $caps, $cap, $user_id, $args );
+    // Filter & return
+    return (array) apply_filters( 'bbp_map_primary_meta_caps', $caps, $cap, $user_id, $args );
 }
 
@@ -167 +168 @@
     }
 
+    // Filter & return
     return apply_filters( 'bbp_set_user_role', $new_role, $user_id, $user );
 }
@@ -205 +207 @@
     }
 
+    // Filter & return
     return apply_filters( 'bbp_get_user_role', $role, $user_id, $user );
 }
@@ -243 +246 @@
     }
 
+    // Filter & return
     return apply_filters( 'bbp_get_user_blog_role', $role, $user_id, $user );
 }
@@ -393 +397 @@
     $default_role = bbp_get_default_role();
 
-    // Return filtered results, forcing admins to keymasters.
+    // Filter & return
     return (array) apply_filters( 'bbp_get_user_role_map', array (
         'administrator' => bbp_get_keymaster_role(),
@@ -440 +444 @@
     }
 
+    // Filter & return
     return (bool) apply_filters( 'bbp_core_is_user_spammer', $is_spammer );
 }
@@ -661 +666 @@
     }
 
+    // Filter & return
     return (bool) apply_filters( 'bbp_core_is_user_deleted', $is_deleted );
 }
@@ -744 +750 @@
     $_user_id = (int) ! empty( $user_id ) ? $user_id : bbp_get_current_user_id();
 
-    // Filter and return
+    // Filter & return
     return (bool) apply_filters( 'bbp_is_user_keymaster', user_can( $_user_id, 'keep_gate' ), $_user_id, $user_id );
 }
@@ -783 +789 @@
     }
 
-    // Filter and return
+    // Filter & return
     return (bool) apply_filters( 'bbp_show_user_profile', $retval, $user_id );
 }
@@ -855 +861 @@
     }
 
-    return apply_filters( 'bbp_get_moderators', $users, $object_id );
-}
+    // Filter & return
+    return (array) apply_filters( 'bbp_get_moderators', $users, $object_id );
+}