Summery Summery
Delete user option with global blog capability.
Syntax Syntax
Description 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 Parameters
- $user_id
-
(Required) User ID
- $option_name
-
(Required) User option name.
- $global
-
(Optional) Whether option name is global or blog specific. Default false (blog specific).
Default value: false
Return Return
(bool) True on success, false on failure.
Source 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 ); }
Advertisement
Changelog Changelog
Version | Description |
---|---|
3.0.0 | Introduced. |