bp_update_user_meta( int $user_id, string $key, mixed $value, mixed $prev_value = '' )
Update a piece of usermeta.
Description Description
This is a wrapper for update_user_meta() that allows for easy use of bp_get_user_meta_key(), thereby increasing compatibility with non-standard BP setups.
See also See also
- update_user_meta(): For complete details about parameters and return values.
Parameters Parameters
- $user_id
-
(Required) The ID of the user whose meta you're setting.
- $key
-
(Required) The meta key to set.
- $value
-
(Required) Metadata value.
- $prev_value
-
(Optional) Previous value to check before removing.
Default value: ''
Return Return
(bool) False on failure, true on success.
Source Source
File: bp-core/bp-core-functions.php
function bp_update_user_meta( $user_id, $key, $value, $prev_value = '' ) {
return update_user_meta( $user_id, bp_get_user_meta_key( $key ), $value, $prev_value );
}
Changelog Changelog
| Version | Description |
|---|---|
| 1.5.0 | Introduced. |