bp_groups_remove_group_type( int $group_id, string $group_type )

Remove type for a group.

Description

Parameters

$group_id: (Required) ID of the user.
$group_type: (Required) Group type.

Return

(bool|WP_Error) $deleted True on success. False or WP_Error on failure.

Source

function bp_groups_remove_group_type( $group_id, $group_type ) {
    if ( empty( $group_type ) || ! bp_groups_get_group_type_object( $group_type ) ) {
        return false;
    }
 
    $deleted = bp_remove_object_terms( $group_id, $group_type, 'bp_group_type' );
 
    // Bust the case, if the type has been removed.
    if ( ! is_wp_error( $deleted ) ) {
        wp_cache_delete( $group_id, 'bp_groups_group_type' );
 
        /**
         * Fires just after a group's group type has been removed.
         *
         * @since BuddyPress 2.6.0
         *
         * @param int    $group      ID of the group whose group type has been removed.
         * @param string $group_type Group type.
         */
        do_action( 'bp_groups_remove_group_type', $group_id, $group_type );
    }
 
    return $deleted;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 2.6.0	Introduced.

Uses

Uses
Uses	Description
bp-groups/bp-groups-functions.php: bp_groups_remove_group_type	Fires just after a group’s group type has been removed.
bp-groups/bp-groups-functions.php: bp_groups_get_group_type()	Get type for a group.
bp-groups/bp-groups-functions.php: bp_groups_get_group_type_object()	Retrieve a group type object by name.
bp-core/bp-core-taxonomy.php: bp_remove_object_terms()	Remove taxonomy terms on a BuddyPress object.

Used By
Used By	Description
bp-groups/classes/class-bp-rest-groups-endpoint.php: BP_REST_Groups_Endpoint::prepare_item_for_database()	Prepare a group for create or update.
bp-groups/bp-groups-admin.php: bp_groups_admin_process_group_type_bulk_changes()	Process input from the Group Type bulk change select.

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