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

Delete 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 ‘global’ parameter is false, which it is by default it will prepend the WordPress table prefix to the option name.

Parameters

$user_id

(int) (Required) User ID

$option_name

(string) (Required) User option name.

$global

(bool) (Optional) Whether option name is global or blog specific. Default false (blog specific).

Default value: false

Return

(bool) True on success, false on failure.

Source

File: wp-includes/user.php

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

	if ( ! $global ) {
		$option_name = $wpdb->get_blog_prefix() . $option_name;
	}
	return delete_user_meta( $user_id, $option_name );
}

Changelog

Version Description
3.0.0 Introduced.

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