WordPress at a glance
Home All Function Functions Multisite Users

delete_user_option() WP 1.0

Delete user option with global blog capability.

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.

Works based on: delete_user_meta()

No Hooks.

Return

true/false. True on success, false on failure.

Usage

delete_user_option( $user_id, $option_name, $global );
$user_id(int) (required)
User ID
$option_name(string) (required)
User option name.
$global(true/false)
Whether option name is global or blog specific.
Default: false (blog specific)

Notes

  • Global. wpdb. $wpdb WordPress database abstraction object.

Changelog

Since 3.0.0 Introduced.

Code of delete user option: wp-includes/user.php WP 5.2.4

<?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 );
}

Related Functions

From tag: Users (_user)

More from category: Users

No comments
    Hello, !     Log In . Register