update_user_option( int $user_id, string $option_name, mixed $newvalue, bool $is_global = false ): int|bool
- Since
- 2.0.0
- Source
wp-includes/user.php:813
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.
Deletes the user option if $newvalue is empty.
Compatibility
- WordPress
- since 2.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.
$newvaluemixed- User option value.
$is_globalbooloptional- Whether option name is global or blog specific.
Default false (blog specific).Default:false
Return value
int|bool- User meta ID if the option didn't exist, true on successful update, false on failure.
Performance profile
How much work a call to update_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
- Scaling
- Constant
- Instructions
- 12–16
- Plugin surface
- None
- Called by
- 4
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 16.
Nothing here hands control to plugin code.
4 places 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 update_user_option() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 12 | update_user_meta() |
| always | 16 | ->get_blog_prefix(), update_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: 16 instructions, 12–16 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
- update_user_meta()Updates user meta field based on user ID.
Used by · 4
- delete_all_user_settings()Deletes the user settings of the current user.
- wp_dashboard_quick_press()Displays the Quick Draft widget.
- wp_set_all_user_settings()Private. Sets all user interface settings.
- wp_user_settings()Saves and restores user interface settings stored in a cookie.
Source code
function update_user_option( $user_id, $option_name, $newvalue, $is_global = false ) { global $wpdb; if ( ! $is_global ) { $option_name = $wpdb->get_blog_prefix() . $option_name; } return update_user_meta( $user_id, $option_name, $newvalue );}Changelog
Introduced in 2.0.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 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.