Contents

Code Reference Functions groups_delete_groupmeta()

groups_delete_groupmeta( int $group_id, string|bool $meta_key = false, string|bool $meta_value = false, bool $delete_all = false )

Delete metadata for a group.

Description

Parameters

$group_id

(Required) ID of the group.

$meta_key

(Optional) The key of the row to delete.

Default value: false

$meta_value

(Optional) Metadata value. If specified, only delete metadata entries with this value.

Default value: false

$delete_all

(Optional) If true, delete matching metadata entries for all groups. Otherwise, only delete matching metadata entries for the specified group. Default: false.

Default value: false

Return

(bool) True on success, false on failure.

Source

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

2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
function groups_delete_groupmeta( $group_id, $meta_key = false, $meta_value = false, $delete_all = false ) {
    global $wpdb;
 
    // Legacy - if no meta_key is passed, delete all for the item.
    if ( empty( $meta_key ) ) {
        $keys = $wpdb->get_col( $wpdb->prepare( "SELECT meta_key FROM {$wpdb->groupmeta} WHERE group_id = %d", $group_id ) );
 
        // With no meta_key, ignore $delete_all.
        $delete_all = false;
    } else {
        $keys = array( $meta_key );
    }
 
    add_filter( 'query', 'bp_filter_metaid_column_name' );
 
    $retval = true;
    foreach ( $keys as $key ) {
        $retval = delete_metadata( 'group', $group_id, $key, $meta_value, $delete_all );
    }
 
    remove_filter( 'query', 'bp_filter_metaid_column_name' );
 
    return $retval;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyPress 1.0.0 Introduced.

Uses

Uses
Uses Description
bp-loader.php: buddypress()

The main function responsible for returning the one true BuddyBoss Instance to functions everywhere.
Used By
Used By Description
bp-groups/bp-groups-functions.php: bp_groups_reset_cover_image_position()

Reset cover image position while uploading/deleting groups cover photo.
bp-forums/groups.php: BBP_Forums_Group_Extension::create_screen_save()

Save the Group Forum data on create
bp-groups/classes/class-bp-groups-group.php: BP_Groups_Group::delete()

Delete the current group.
bp-groups/bp-groups-functions.php: groups_edit_base_group_details()

Edit the base details for a group.
bp-integrations/learndash/library/SyncGenerator.php: SyncGenerator::unsetLdGroupMeta()

Remove ld group id from current bp group
bp-integrations/learndash/buddypress/Helpers.php: Helpers::deleteLearndashGroupId()

Remove ld group connection from a bp group
bp-core/bp-core-filters.php: bp_dd_delete_avatar()

Delete avatar of group and user
bp-core/bp-core-filters.php: bp_dd_delete_group_cover_images_url()

Delete the group cover photo attachment
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.