groups_delete_group( int $group_id )
Delete a group and all of its associated metadata.
Description Description
Parameters Parameters
- $group_id
-
(Required) ID of the group to delete.
Return Return
(bool) True on success, false on failure.
Source Source
File: bp-groups/bp-groups-functions.php
function groups_delete_group( $group_id ) {
/**
* Fires before the deletion of a group.
*
* @since 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 1.0.0
*
* @param int $group_id ID of the group that was deleted.
*/
do_action( 'groups_delete_group', $group_id );
return true;
}
Changelog Changelog
| Version | Description |
|---|---|
| 1.0.0 | Introduced. |