cp_update_relationship_meta( int $relationship_id, string $meta_key, mixed $meta_value, mixed $prev_value = '' )
Updates relationship metadata.
Description
Use the $prev_value parameter to differentiate between meta fields with the same key and relationship ID.
If the meta field for the term does not exist, it will be added.
Parameters
- $relationship_id
-
(Required) Relationship ID.
- $meta_key
-
(Required) Metadata key.
- $meta_value
-
(Required) Metadata value. Must be serializable if non-scalar.
- $prev_value
-
(Optional) Previous value to check before updating.<br> If specified, only update existing metadata entries with this value. Otherwise, update all entries.
Default value: ''
Return
(int|bool|WP_Error) Meta ID if the key didn't exist. true on successful update, false on failure or if the value passed to the function is the same as the one that is already in the database.<br> WP_Error when relationship_id is ambiguous between relationships.
Source
File: wp-includes/object-relationships.php
function cp_update_relationship_meta( $relationship_id, $meta_key, $meta_value, $prev_value = '' ) {
return update_metadata( 'object_relationship', $relationship_id, $meta_key, $meta_value, $prev_value );
}
Changelog
| Version | Description |
|---|---|
| CP-2.2.0 | Introduced. CP-2.2.0 |