bp_messages_update_meta( int $message_id, string|bool $meta_key, string|bool $meta_value, string $prev_value = '' )
Update a piece of message metadata.
Description Description
See also See also
- update_metadata(): for full documentation excluding $meta_type variable.
Parameters Parameters
- $message_id
-
(Required) ID of the message to have meta deleted for.
- $meta_key
-
(Required) Meta key to update.
- $meta_value
-
(Required) Meta value to update.
- $prev_value
-
(Optional) If specified, only update existing metadata entries with the specified value. Otherwise, update all entries.
Default value: ''
Return Return
(mixed)
Source Source
File: bp-messages/bp-messages-functions.php
function bp_messages_update_meta( $message_id, $meta_key, $meta_value, $prev_value = '' ) {
add_filter( 'query', 'bp_filter_metaid_column_name' );
$retval = update_metadata( 'message', $message_id, $meta_key, $meta_value, $prev_value );
remove_filter( 'query', 'bp_filter_metaid_column_name' );
return $retval;
}
Changelog Changelog
| Version | Description |
|---|---|
| 2.2.0 | Introduced. |