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

Description

Parameters

$user_idint

User ID

$option_namestring

User option name.

$is_globalbooloptional

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

Return

bool

True on success, false on failure.

Uses · 1

• delete_user_meta()Removes metadata matching criteria from a user.

Used by · 1

• wpmu_create_user()Creates a user.

Source

View on Trac ↗View on GitHub ↗

823function delete_user_option( $user_id, $option_name, $is_global = false ) {824	global $wpdb;825 826	if ( ! $is_global ) {827		$option_name = $wpdb->get_blog_prefix() . $option_name;828	}829 830	return delete_user_meta( $user_id, $option_name );831}

History

Introduced in 3.0.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.8.8 tag, from src/wp-includes/user.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.