delete_user_option() – Function | Developer.WordPress.org

delete_user_option( int $user_id, string $option_name, bool $is_global = false ): bool

Deletes user option with global blog capability.

Description

User options are just like user metadata except that they have support for global blog options. If the ‘is_global’ parameter is false, which it is by default, it will prepend the WordPress table prefix to the option name.

Parameters

$user_idintrequired: User ID
$option_namestringrequired: User option name.
$is_globalbooloptional: Whether option name is global or blog specific.
Default false (blog specific).
Default:false

Return

bool True on success, false on failure.

Source

function delete_user_option( $user_id, $option_name, $is_global = false ) {
	global $wpdb;

	if ( ! $is_global ) {
		$option_name = $wpdb->get_blog_prefix() . $option_name;
	}

	return delete_user_meta( $user_id, $option_name );
}

View all references View on Trac View on GitHub

Uses	Description
delete_user_meta()`wp-includes/user.php`	Removes metadata matching criteria from a user.
wpdb::get_blog_prefix()`wp-includes/class-wpdb.php`	Gets blog prefix.

Used by	Description
wpmu_create_user()`wp-includes/ms-functions.php`	Creates a user.

Changelog

Version	Description
3.0.0	Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.