W3cubDocs

/WordPress

wpmu_delete_user( int $id )

Delete a user from the network and remove from all sites.

Parameters

$id

(int) (Required) The user ID.

Return

(bool) True if the user was deleted, otherwise false.

Source

File: wp-admin/includes/ms.php 

function wpmu_delete_user( $id ) {
	global $wpdb;

	if ( ! is_numeric( $id ) ) {
		return false;
	}

	$id   = (int) $id;
	$user = new WP_User( $id );

	if ( ! $user->exists() ) {
		return false;
	}

	// Global super-administrators are protected, and cannot be deleted.
	$_super_admins = get_super_admins();
	if ( in_array( $user->user_login, $_super_admins, true ) ) {
		return false;
	}

	/**
	 * Fires before a user is deleted from the network.
	 *
	 * @since MU (3.0.0)
	 * @since 5.5.0 Added the `$user` parameter.
	 *
	 * @param int     $id   ID of the user about to be deleted from the network.
	 * @param WP_User $user WP_User object of the user about to be deleted from the network.
	 */
	do_action( 'wpmu_delete_user', $id, $user );

	$blogs = get_blogs_of_user( $id );

	if ( ! empty( $blogs ) ) {
		foreach ( $blogs as $blog ) {
			switch_to_blog( $blog->userblog_id );
			remove_user_from_blog( $id, $blog->userblog_id );

			$post_ids = $wpdb->get_col( $wpdb->prepare( "SELECT ID FROM $wpdb->posts WHERE post_author = %d", $id ) );
			foreach ( (array) $post_ids as $post_id ) {
				wp_delete_post( $post_id );
			}

			// Clean links.
			$link_ids = $wpdb->get_col( $wpdb->prepare( "SELECT link_id FROM $wpdb->links WHERE link_owner = %d", $id ) );

			if ( $link_ids ) {
				foreach ( $link_ids as $link_id ) {
					wp_delete_link( $link_id );
				}
			}

			restore_current_blog();
		}
	}

	$meta = $wpdb->get_col( $wpdb->prepare( "SELECT umeta_id FROM $wpdb->usermeta WHERE user_id = %d", $id ) );
	foreach ( $meta as $mid ) {
		delete_metadata_by_mid( 'user', $mid );
	}

	$wpdb->delete( $wpdb->users, array( 'ID' => $id ) );

	clean_user_cache( $user );

	/** This action is documented in wp-admin/includes/user.php */
	do_action( 'deleted_user', $id, null, $user );

	return true;
}

Uses

Uses Description
wp-admin/includes/ms.php: wpmu_delete_user

Fires before a user is deleted from the network.
wp-admin/includes/user.php: deleted_user

Fires immediately after a user is deleted from the database.
wp-admin/includes/bookmark.php: wp_delete_link()

Deletes a specified link from the database.
wp-includes/class-wp-user.php: WP_User::__construct()

Constructor.
wp-includes/capabilities.php: get_super_admins()

Retrieve a list of super admins.
wp-includes/plugin.php: do_action()

Execute functions hooked on a specific action hook.
wp-includes/user.php: clean_user_cache()

Clean all user caches
wp-includes/user.php: get_blogs_of_user()

Get the sites a user belongs to.
wp-includes/post.php: wp_delete_post()

Trash or delete a post or page.
wp-includes/ms-functions.php: remove_user_from_blog()

Remove a user from a blog.
wp-includes/ms-blogs.php: switch_to_blog()

Switch the current blog.
wp-includes/ms-blogs.php: restore_current_blog()

Restore the current blog, after calling switch_to_blog().
wp-includes/wp-db.php: wpdb::get_col()

Retrieves one column from the database.
wp-includes/wp-db.php: wpdb::delete()

Deletes a row in the table.
wp-includes/wp-db.php: wpdb::prepare()

Prepares a SQL query for safe execution.
wp-includes/meta.php: delete_metadata_by_mid()

Deletes metadata by meta ID.

Changelog

Version Description
3.0.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/wpmu_delete_user