bbp_add_user_to_object( int $object_id, int $user_id, string $rel_key = '', string $rel_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
- $rel_key
-
(Optional) The relationship key
Default value: ''
- $rel_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/users/engagements.php
function bbp_add_user_to_object( $object_id = 0, $user_id = 0, $rel_key = '', $rel_type = 'post', $unique = false ) {
$object_id = absint( $object_id );
$user_id = absint( $user_id );
$retval = bbp_user_engagements_interface( $rel_key, $rel_type )->add_user_to_object( $object_id, $user_id, $rel_key, $rel_type, $unique );
// Filter & return
return (bool) apply_filters( 'bbp_add_user_to_object', $retval, $object_id, $user_id, $rel_key, $rel_type, $unique );
}
Changelog Changelog
| Version | Description |
|---|---|
| 2.6.0 | Introduced. |