Changeset 10795 for trunk/src/bp-groups/bp-groups-functions.php

Timestamp:

05/21/2016 02:20:45 AM (8 years ago)

Author:

boonebgorges

Message:

Correct @return documentation for groups_is_user_*() functions.

They have always said bool. That has always been false.
Fixes #6327.

File:

• trunk/src/bp-groups/bp-groups-functions.php (modified) (6 diffs)

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

@@ -996 +996 @@
  * @param int $user_id ID of the user.
  * @param int $group_id ID of the group.
- * @return bool
+ * @return int|bool ID of the membership if the user is admin, otherwise false.
  */
 function groups_is_user_admin( $user_id, $group_id ) {
@@ -1019 +1019 @@
  * @param int $user_id ID of the user.
  * @param int $group_id ID of the group.
- * @return bool
+ * @return int|bool ID of the membership if the user is mod, otherwise false.
  */
 function groups_is_user_mod( $user_id, $group_id ) {
@@ -1042 +1042 @@
  * @param int $user_id ID of the user.
  * @param int $group_id ID of the group.
- * @return bool
+ * @return int|bool ID of the membership if the user is member, otherwise false.
  */
 function groups_is_user_member( $user_id, $group_id ) {
@@ -1066 +1066 @@
  * @param int $user_id  ID of the user.
  * @param int $group_id ID of the group.
- *
- * @return bool
+ * @return int|bool ID of the membership if the user is banned, otherwise false.
  */
 function groups_is_user_banned( $user_id, $group_id ) {
@@ -1091 +1090 @@
  * @param int $user_id ID of the user.
  * @param int $group_id ID of the group.
- * @return int|null ID of the membership if found.
+ * @return int|bool ID of the membership if the user is invited, otherwise false.
  */
 function groups_is_user_invited( $user_id, $group_id ) {
@@ -1115 +1114 @@
  * @param int $user_id ID of the user.
  * @param int $group_id ID of the group.
- * @return int|null ID of the membership if found.
+ * @return int|bool ID of the membership if the user is pending, otherwise false.
  */
 function groups_is_user_pending( $user_id, $group_id ) {