Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
06/02/2024 01:06:10 AM (6 months ago)
Author:
espellcaste
Message:

PHPDoc: remove superfluous comments from boolean returns.

See #9164

File:
1 edited

Legend:

Unmodified
Added
Removed

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

    r13874 r13890  
    323323 *                                  members about changes in these details.
    324324 * }
    325  * @return bool True on success, false on failure.
     325 * @return bool
    326326 */
    327327function groups_edit_base_group_details( $args = array() ) {
    … …  
    420420 *                                   to the group. 'members', 'mods', or 'admins'.
    421421 * @param int|bool    $parent_id     Parent group ID.
    422  * @return bool True on success, false on failure.
     422 * @return bool
    423423 */
    424424function groups_edit_group_settings( $group_id, $enable_forum, $status, $invite_status = false, $parent_id = false ) {
    … …  
    469469 *
    470470 * @param int $group_id ID of the group to delete.
    471  * @return bool True on success, false on failure.
     471 * @return bool
    472472 */
    473473function groups_delete_group( $group_id ) {
    … …  
    604604 * @param int                        $user_id Optional. ID of the user. Defaults to the currently
    605605 *                                            logged-in user.
    606  * @return bool True on success, false on failure.
     606 * @return bool
    607607 */
    608608function groups_leave_group( $group, $user_id = 0 ) {
    … …  
    656656 * @param int                        $user_id Optional. ID of the user. Defaults to the currently
    657657 *                                            logged-in user.
    658  * @return bool True on success, false on failure.
     658 * @return bool
    659659 */
    660660function groups_join_group( $group, $user_id = 0 ) {
    … …  
    12911291 * @since 12.0.0
    12921292 *
    1293  * @return boolean True if the current user can access to the current group.
     1293 * @return bool True if the current user can access to the current group.
    12941294 *                 False otherwise.
    12951295 */
    … …  
    16401640 *                                 sent now. Default: false.
    16411641 * }
    1642  * @return bool True on success, false on failure.
     1642 * @return bool
    16431643 */
    16441644function groups_invite_user( $args = '' ) {
    … …  
    16911691 * @param int $group_id ID of the group.
    16921692 * @param int $inviter_id ID of the inviter.
    1693  * @return bool True on success, false on failure.
     1693 * @return bool
    16941694 */
    16951695function groups_uninvite_user( $user_id, $group_id, $inviter_id = false ) {
    … …  
    17541754 * @param int $inviter_id ID of the inviter.
    17551755 *
    1756  * @return bool True on success, false on failure.
     1756 * @return bool
    17571757 */
    17581758function groups_reject_invite( $user_id, $group_id, $inviter_id = false ) {
    … …  
    17931793 * @param int $inviter_id ID of the inviter.
    17941794 *
    1795  * @return bool True on success, false on failure.
     1795 * @return bool
    17961796 */
    17971797function groups_delete_invite( $user_id, $group_id, $inviter_id = false ) {
    … …  
    20212021 * @param string $status         The new status. 'mod' or 'admin'.
    20222022 * @param int    $group_admin_id Optional. The group admin user ID.
    2023  * @return bool True on success, false on failure.
     2023 * @return bool
    20242024 */
    20252025function groups_promote_member( $user_id, $group_id, $status, $group_admin_id = 0 ) {
    … …  
    20792079 * @param int $group_id ID of the group.
    20802080 * @param int $group_admin_id Optional. The group admin user ID.
    2081  * @return bool True on success, false on failure.
     2081 * @return bool
    20822082 */
    20832083function groups_demote_member( $user_id, $group_id, $group_admin_id = 0 ) {
    … …  
    21332133 * @param int $group_id ID of the group.
    21342134 * @param int $group_admin_id Optional. The group admin user ID.
    2135  * @return bool True on success, false on failure.
     2135 * @return bool
    21362136 */
    21372137function groups_ban_member( $user_id, $group_id, $group_admin_id = 0 ) {
    … …  
    21872187 * @param int $group_id ID of the group.
    21882188 * @param int $group_admin_id Optional. The group admin user ID.
    2189  * @return bool True on success, false on failure.
     2189 * @return bool
    21902190 */
    21912191function groups_unban_member( $user_id, $group_id, $group_admin_id = 0 ) {
    … …  
    22432243 * @param int $group_id ID of the group.
    22442244 * @param int $group_admin_id Optional. The group admin user ID.
    2245  * @return bool True on success, false on failure.
     2245 * @return bool
    22462246 */
    22472247function groups_remove_member( $user_id, $group_id, $group_admin_id = 0 ) {
    … …  
    23012301 *                                 Default: current date/time.
    23022302 * }
    2303  * @return bool True on success, false on failure.
     2303 * @return bool
    23042304 */
    23052305function groups_send_membership_request( ...$args ) {
    … …  
    23752375 *                           requested. Provide this value along with $user_id to
    23762376 *                           override $membership_id.
    2377  * @return bool True on success, false on failure.
     2377 * @return bool
    23782378 */
    23792379function groups_accept_membership_request( $membership_id, $user_id = 0, $group_id = 0 ) {
    … …  
    24092409 *                           requested. Provide this value along with $user_id to
    24102410 *                           override $membership_id.
    2411  * @return bool True on success, false on failure.
     2411 * @return bool
    24122412 */
    24132413function groups_reject_membership_request( $membership_id, $user_id = 0, $group_id = 0 ) {
    … …  
    25582558 *
    25592559 * @param int $group_id ID of the group.
    2560  * @return bool True on success, false on failure.
     2560 * @return bool
    25612561 */
    25622562function groups_accept_all_pending_membership_requests( $group_id = 0 ) {
    … …  
    26042604 *                                metadata entries for the specified group.
    26052605 *                                Default: false.
    2606  * @return bool True on success, false on failure.
     2606 * @return bool
    26072607 */
    26082608function groups_delete_groupmeta( $group_id, $meta_key = false, $meta_value = false, $delete_all = false ) {
Note: See TracChangeset for help on using the changeset viewer.