BBP_User_Engagements_User::add_user_to_object( int $object_id, int $user_id, string $meta_key = '', string $meta_type = 'post', bool $unique = false )
Add a user id to an object
Description Description
Parameters Parameters
- $object_id
-
(Required) The object id
- $user_id
-
(Required) The user id
- $meta_key
-
(Optional) The relationship key
Default value: ''
- $meta_type
-
(Optional) The relationship type (usually 'post')
Default value: 'post'
- $unique
-
(Optional) Whether meta key should be unique to the object
Default value: false
Return Return
(bool) Returns true on success, false on failure
Source Source
File: includes/common/engagements.php
public function add_user_to_object( $object_id = 0, $user_id = 0, $meta_key = '', $meta_type = 'post', $unique = false ) {
$retval = false;
$option_key = $this->get_user_option_key( $meta_key, $object_id );
$object_ids = $this->parse_comma_list( get_user_option( $option_key, $user_id ) );
$exists = array_search( $object_id, $object_ids );
// Not already added, so add it
if ( false === $exists ) {
$object_ids[] = $object_id;
$object_ids = implode( ',', $this->parse_comma_list( $object_ids ) );
$retval = update_user_option( $user_id, $option_key, $object_ids );
// Delete cache if successful (accounts for int & true)
if ( false !== $retval ) {
$this->cache_delete( $meta_key, $object_id );
}
}
// Return true if added, or false if not
return $retval;
}
Changelog Changelog
| Version | Description |
|---|---|
| 2.6.0 | Introduced. |