bp_is_user_deleted( int $user_id )
Check whether a user has been marked as deleted.
Description
Parameters
- $user_id
-
(Required) The ID for the user.
Return
(bool) True if deleted, otherwise false.
Source
File: bp-members/bp-members-functions.php
function bp_is_user_deleted( $user_id = 0 ) {
// No user to check.
if ( empty( $user_id ) ) {
return false;
}
$bp = buddypress();
// Assume user is not deleted.
$is_deleted = false;
// Setup our user.
$user = false;
// Get locally-cached data if available.
switch ( $user_id ) {
case bp_loggedin_user_id() :
$user = ! empty( $bp->loggedin_user->userdata ) ? $bp->loggedin_user->userdata : false;
break;
case bp_displayed_user_id() :
$user = ! empty( $bp->displayed_user->userdata ) ? $bp->displayed_user->userdata : false;
break;
}
// Manually get userdata if still empty.
if ( empty( $user ) ) {
$user = get_userdata( $user_id );
}
// No user found.
if ( empty( $user ) ) {
$is_deleted = true;
// User found.
} else {
// Check if deleted.
if ( !empty( $user->deleted ) ) {
$is_deleted = true;
}
if ( 2 == $user->user_status ) {
$is_deleted = true;
}
}
/**
* Filters whether a user is marked as deleted.
*
* @since BuddyPress 1.6.0
*
* @param bool $is_deleted Whether or not user is marked as deleted.
*/
return apply_filters( 'bp_is_user_deleted', (bool) $is_deleted );
}
Changelog
| Version | Description |
|---|---|
| BuddyPress 1.6.0 | Introduced. |
Questions?
We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.