wpmu_delete_user( int $id ): bool

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$idint

The user ID.

Return value

bool

True if the user was deleted, false otherwise.

Performance profile

How much work a call to wpmu_delete_user() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via ->get_col().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

5–66

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 128.

Plugin surface

2 hooks

Third-party callbacks on 'wpmu_delete_user', 'deleted_user' run inside this call, and their cost is not bounded by anything here.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksdo_action()called directly
• sqldatabase query->get_col()called directly
• optionnetwork optionget_site_option()one call below wpmu_delete_user()
• cacheobject cachewp_cache_switch_to_blog()one call below wpmu_delete_user()
• querycontent queryget_post()one call below wpmu_delete_user()

Further down the call graph this can also reach serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 4 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wpmu_delete_user() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 2

2 hooks fire while wpmu_delete_user() runs, in this order:

1. 1
   do_action( wpmu_delete_user )actionline 174 (+29 into the body)

   Fires before a user is deleted from the network.

2. 2
   do_action( deleted_user )actionline 211 (+66 into the body)

   Fires immediately after a user is deleted from the site.

Uses · 11

• get_super_admins()Retrieves a list of super admins.
• do_action()Calls the callback functions that have been added to an action hook.
• get_blogs_of_user()Gets the sites a user belongs to.
• switch_to_blog()Switches the current blog.
• remove_user_from_blog()Removes a user from a blog.
• wp_delete_post()Trashes or deletes a post or page.
• wp_delete_link()Deletes a specified link from the database.
• restore_current_blog()Restores the current blog, after calling switch_to_blog().
• delete_metadata_by_mid()Deletes metadata by meta ID.
• clean_user_cache()Cleans all user caches.
• WP_User::__construct()Constructor.

Source code

View on Trac ↗View on GitHub ↗

145function wpmu_delete_user( $id ) {146	global $wpdb;147 148	if ( ! is_numeric( $id ) ) {149		return false;150	}151 152	$id   = (int) $id;153	$user = new WP_User( $id );154 155	if ( ! $user->exists() ) {156		return false;157	}158 159	// Global super-administrators are protected, and cannot be deleted.160	$_super_admins = get_super_admins();161	if ( in_array( $user->user_login, $_super_admins, true ) ) {162		return false;163	}164 165	/**166	 * Fires before a user is deleted from the network.167	 *168	 * @since MU (3.0.0)169	 * @since 5.5.0 Added the `$user` parameter.170	 *171	 * @param int     $id   ID of the user about to be deleted from the network.172	 * @param WP_User $user WP_User object of the user about to be deleted from the network.173	 */174	do_action( 'wpmu_delete_user', $id, $user );175 176	$blogs = get_blogs_of_user( $id );177 178	if ( ! empty( $blogs ) ) {179		foreach ( $blogs as $blog ) {180			switch_to_blog( $blog->userblog_id );181			remove_user_from_blog( $id, $blog->userblog_id );182 183			$post_ids = $wpdb->get_col( $wpdb->prepare( "SELECT ID FROM $wpdb->posts WHERE post_author = %d", $id ) );184			foreach ( (array) $post_ids as $post_id ) {185				wp_delete_post( $post_id );186			}187 188			// Clean links.189			$link_ids = $wpdb->get_col( $wpdb->prepare( "SELECT link_id FROM $wpdb->links WHERE link_owner = %d", $id ) );190 191			if ( $link_ids ) {192				foreach ( $link_ids as $link_id ) {193					wp_delete_link( $link_id );194				}195			}196 197			restore_current_blog();198		}199	}200 201	$meta = $wpdb->get_col( $wpdb->prepare( "SELECT umeta_id FROM $wpdb->usermeta WHERE user_id = %d", $id ) );202	foreach ( $meta as $mid ) {203		delete_metadata_by_mid( 'user', $mid );204	}205 206	$wpdb->delete( $wpdb->users, array( 'ID' => $id ) );207 208	clean_user_cache( $user );209 210	/** This action is documented in wp-admin/includes/user.php */211	do_action( 'deleted_user', $id, null, $user );212 213	return true;214}

Changelog

Introduced in 3.0.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-admin/includes/ms.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.