delete_user_option( int $user_id, string $option_name, bool $is_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 ‘is_global’ parameter is false, which it is by default, it will prepend the WordPress table prefix to the option name.
Parameters
- $user_id
-
(Required) User ID
- $option_name
-
(Required) User option name.
- $is_global
-
(Optional) Whether option name is global or blog specific.<br> 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. |