Skip to:
Content

BuddyPress.org

Changeset 10795


Ignore:
Timestamp:
05/21/2016 02:20:45 AM (4 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:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-groups/bp-groups-functions.php

    r10794 r10795  
    996996 * @param int $user_id ID of the user.
    997997 * @param int $group_id ID of the group.
    998  * @return bool
     998 * @return int|bool ID of the membership if the user is admin, otherwise false.
    999999 */
    10001000function groups_is_user_admin( $user_id, $group_id ) {
     
    10191019 * @param int $user_id ID of the user.
    10201020 * @param int $group_id ID of the group.
    1021  * @return bool
     1021 * @return int|bool ID of the membership if the user is mod, otherwise false.
    10221022 */
    10231023function groups_is_user_mod( $user_id, $group_id ) {
     
    10421042 * @param int $user_id ID of the user.
    10431043 * @param int $group_id ID of the group.
    1044  * @return bool
     1044 * @return int|bool ID of the membership if the user is member, otherwise false.
    10451045 */
    10461046function groups_is_user_member( $user_id, $group_id ) {
     
    10661066 * @param int $user_id  ID of the user.
    10671067 * @param int $group_id ID of the group.
    1068  *
    1069  * @return bool
     1068 * @return int|bool ID of the membership if the user is banned, otherwise false.
    10701069 */
    10711070function groups_is_user_banned( $user_id, $group_id ) {
     
    10911090 * @param int $user_id ID of the user.
    10921091 * @param int $group_id ID of the group.
    1093  * @return int|null ID of the membership if found.
     1092 * @return int|bool ID of the membership if the user is invited, otherwise false.
    10941093 */
    10951094function groups_is_user_invited( $user_id, $group_id ) {
     
    11151114 * @param int $user_id ID of the user.
    11161115 * @param int $group_id ID of the group.
    1117  * @return int|null ID of the membership if found.
     1116 * @return int|bool ID of the membership if the user is pending, otherwise false.
    11181117 */
    11191118function groups_is_user_pending( $user_id, $group_id ) {
Note: See TracChangeset for help on using the changeset viewer.