groups_update_groupmeta( int $group_id, string $meta_key, mixed $meta_value, mixed $prev_value = '' )
Update a piece of group metadata.
Description
Parameters
- $group_id
-
(Required) ID of the group.
- $meta_key
-
(Required) Metadata key.
- $meta_value
-
(Required) Value to store.
- $prev_value
-
(Optional) If specified, only update existing metadata entries with the specified value. Otherwise, update all entries.
Default value: ''
Return
(bool|int) $retval Returns false on failure. On successful update of existing metadata, returns true. On successful creation of new metadata, returns the integer ID of the new metadata row.
Source
File: bp-groups/bp-groups-functions.php
2749 2750 2751 2752 2753 2754 2755 | function groups_update_groupmeta( $group_id , $meta_key , $meta_value , $prev_value = '' ) { add_filter( 'query' , 'bp_filter_metaid_column_name' ); $retval = update_metadata( 'group' , $group_id , $meta_key , $meta_value , $prev_value ); remove_filter( 'query' , 'bp_filter_metaid_column_name' ); return $retval ; } |
Changelog
Version | Description |
---|---|
BuddyPress 1.0.0 | Introduced. |
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.