delete_user_option() WordPress Function
The delete_user_option() function is used to delete a user option from the database. This function takes two arguments: the user ID and the option name.
delete_user_option( int $user_id, string $option_name, bool $global = false ) #
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 ‘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 );
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 3.0.0 | Introduced. |