bbp_remove_user_from_all_objects( int $user_id, string $rel_key = '', string $rel_type = 'post' )
Remove a user id from all objects
Description Description
Parameters Parameters
- $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'
Return Return
(bool) Returns true on success, false on failure
Source Source
File: includes/users/engagements.php
function bbp_remove_user_from_all_objects( $user_id = 0, $rel_key = '', $rel_type = 'post' ) {
$user_id = absint( $user_id );
$retval = bbp_user_engagements_interface( $rel_key, $rel_type )->remove_user_from_all_objects( $user_id, $rel_key, $rel_type );
// Filter & return
return (bool) apply_filters( 'bbp_remove_user_from_all_objects', $retval, $user_id, $rel_key, $rel_type );
}
Changelog Changelog
| Version | Description |
|---|---|
| 2.6.0 | Introduced. |