groups_update_groupmeta( int $group_id, string $meta_key, mixed $meta_value, mixed $prev_value = '' )
Update a piece of group metadata.
Parameters Parameters
- $group_id
-
(int) (Required) ID of the group.
- $meta_key
-
(string) (Required) Metadata key.
- $meta_value
-
(mixed) (Required) Value to store.
- $prev_value
-
(mixed) (Optional) If specified, only update existing metadata entries with the specified value. Otherwise, update all entries.
Default value: ''
Return 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 Source
File: bp-groups/bp-groups-functions.php
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;
}
Expand full source code Collapse full source code View on Trac
Changelog Changelog
| Version | Description |
|---|---|
| 1.0.0 | Introduced. |