bp_groups_set_group_type( int $group_id, string|array $group_type, bool $append = false )

Set type for a group.

Description

Parameters

$group_id

(Required) ID of the group.

$group_type

(Required) Group type or array of group types to set.

$append

(Optional) True to append this to existing types for group, false to replace. Default: false.

Default value: false

Return

(false|array) $retval See bp_set_object_terms().

Source

File: bp-groups/bp-groups-functions.php

function bp_groups_set_group_type( $group_id, $group_type, $append = false ) {
    // Pass an empty group type to remove group's type.
    if ( ! empty( $group_type ) && is_string( $group_type ) && ! bp_groups_get_group_type_object( $group_type ) ) {
        return false;
    }
 
    // Cast as array.
    $group_type = (array) $group_type;
 
    // Validate group types.
    foreach ( $group_type as $type ) {
        // Remove any invalid group types.
        if ( is_null( bp_groups_get_group_type_object( $type ) ) ) {
            unset( $group_type[ $type ] );
        }
    }
 
    $retval = bp_set_object_terms( $group_id, $group_type, 'bp_group_type', $append );
 
    // Bust the cache if the type has been updated.
    if ( ! is_wp_error( $retval ) ) {
        wp_cache_delete( $group_id, 'bp_groups_group_type' );
 
        /**
         * Fires just after a group type has been changed.
         *
         * @since BuddyPress 2.6.0
         *
         * @param int          $group_id   ID of the group whose group type has been updated.
         * @param string|array $group_type Group type or array of group types.
         * @param bool         $append     Whether the type is being appended to existing types.
         */
        do_action( 'bp_groups_set_group_type', $group_id, $group_type, $append );
    }
 
    return $retval;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 2.7.0 $group_type parameter also accepts an array of group types now.	BuddyPress 2.7.0 $group_type parameter also accepts an array of group types now.
BuddyPress 2.6.0	Introduced.

Uses

Uses
Uses	Description
bp-groups/bp-groups-functions.php: bp_groups_get_group_type_object()	Retrieve a group type object by name.
bp-groups/bp-groups-functions.php: bp_groups_set_group_type	Fires just after a group type has been changed.
bp-core/bp-core-taxonomy.php: bp_set_object_terms()	Set taxonomy terms on a BuddyPress object.

Used By
Used By	Description
bp-groups/classes/class-bp-rest-group-settings-endpoint.php: BP_REST_Group_Settings_Endpoint::update_settings_fields()	Update Group settings.
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/classes/class-bp-rest-groups-endpoint.php: BP_REST_Groups_Endpoint::create_item()	Create a group.
bp-groups/bp-groups-admin.php: bp_groups_admin_process_group_type_bulk_changes()	Process input from the Group Type bulk change select.
bp-groups/bp-groups-admin.php: bp_groups_process_group_type_update()	Process changes from the Group Type metabox.
bp-groups/screens/single/admin/group-settings.php: groups_screen_group_admin_settings()	Handle the display of a group’s admin/group-settings page.
bp-groups/actions/create.php: groups_action_create_group()	Catch and process group creation form submissions.
bp-groups/bp-groups-functions.php: bp_remove_group_type_on_group_delete()	Delete a group’s type when the group is deleted.

Show 3 more used by Hide more used by

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