groups_delete_group( int $group_id )

Delete a group and all of its associated metadata.

Description

Parameters

$group_id: (Required) ID of the group to delete.

Return

(bool) True on success, false on failure.

Source

function groups_delete_group( $group_id ) {
 
    /**
     * Fires before the deletion of a group.
     *
     * @since BuddyPress 1.5.0
     *
     * @param int $group_id ID of the group to be deleted.
     */
    do_action( 'groups_before_delete_group', $group_id );
 
    // Get the group object.
    $group = groups_get_group( $group_id );
 
    // Bail if group cannot be deleted.
    if ( ! $group->delete() ) {
        return false;
    }
 
    // Remove all outstanding invites for this group.
    groups_delete_all_group_invites( $group_id );
 
    /**
     * Fires after the deletion of a group.
     *
     * @since BuddyPress 1.0.0
     *
     * @param int $group_id ID of the group that was deleted.
     */
    do_action( 'groups_delete_group', $group_id );
 
    return true;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 1.0.0	Introduced.

Uses

Uses
Uses	Description
bp-groups/bp-groups-functions.php: groups_delete_all_group_invites()	Delete all invitations to a given group.
bp-groups/bp-groups-functions.php: groups_before_delete_group	Fires before the deletion of a group.
bp-groups/bp-groups-functions.php: groups_delete_group	Fires after the deletion of a group.
bp-groups/bp-groups-functions.php: groups_get_group()	Fetch a single group object.

Used By
Used By	Description
bp-groups/classes/class-bp-rest-groups-endpoint.php: BP_REST_Groups_Endpoint::delete_item()	Delete a group.
bp-groups/bp-groups-admin.php: bp_groups_admin_load()	Set up the Groups admin page.
bp-groups/screens/single/admin/delete-group.php: groups_screen_group_admin_delete_group()	Handle the display of the Delete Group page.
bp-integrations/learndash/library/SyncGenerator.php: SyncGenerator::deleteBpGroup()	delete the bp group without trigging sync
bp-core/bp-core-tools-default-data.php: bp_dd_delete_dummy_groups()	Delete all the forum dummy groups

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.

Contents