wppaste
WordPress

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

Since
3.0.0
Source
wp-includes/user.php:840
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.

Compatibility

WordPress
since 3.0.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

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 value

bool
True on success, false on failure.

Performance profile

How much work a call to delete_user_option() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class
Trivial

Touches nothing outside its own arguments.

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
10–14

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 14.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
1

1 place in core call this, so the cost is paid more often than your own code shows.

What one call costs · 2 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost delete_user_option() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
always10delete_user_meta()
always14->get_blog_prefix(), delete_user_meta()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 14 instructions, 10–14 executed per call, 1 branch. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 1

Used by · 1

Source code

View on Trac View on GitHub 

function delete_user_option( $user_id, $option_name, $is_global = false ) {	global $wpdb; 	if ( ! $is_global ) {		$option_name = $wpdb->get_blog_prefix() . $option_name;	} 	return delete_user_meta( $user_id, $option_name );}

Changelog

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.9.7 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.