wp_set_all_user_settings( array $user_settings ): bool|null
- Since
- 2.8.0
- Source
wp-includes/option.php:1872
Compatibility
- WordPress
- since 2.8.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_settingsarray- User settings.
Return value
bool|null- True if set successfully, false if the current user could not be found.
Null if the current user is not a member of the site.
Performance profile
How much work a call to wp_set_all_user_settings() 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
- Light
- Scaling
- Scales with input
- Instructions
- 7–37
- Plugin surface
- None
- Called by
- 2
Touches nothing outside its own arguments.
The body loops, so the work grows with what you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 53.
Nothing here hands control to plugin code.
2 places in core call this, so the cost is paid more often than your own code shows.
What one call costs · 3 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_set_all_user_settings() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 7 | get_current_user_id() |
!is_user_member_of_blog() | 10 | get_current_user_id(), is_user_member_of_blog() |
is_user_member_of_blog() | 36–37 | get_current_user_id(), is_user_member_of_blog(), rtrim(), parse_str(), update_user_option(), time(), update_user_option() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 53 | 7–37 | 5 | |
| 8.5 | 53 | 7–37 | 5 | |
| 8.4 | 53 | 7–37 | 5 | 6 fewer instructions than PHP 8.3 |
| 8.3 | 59 | 7–37 | 5 | |
| 8.2 | 59 | 7–37 | 5 | |
| 8.1 | 59 | 7–37 | 5 | |
| 7.4 | 59 | 7–37 | 5 |
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 · 3
- get_current_user_id()Gets the current user's ID.
- is_user_member_of_blog()Finds out whether a user is a member of a given blog.
- update_user_option()Updates user option with global blog capability.
Used by · 2
- delete_user_setting()Deletes user interface settings.
- set_user_setting()Adds or updates user interface setting.
Source code
function wp_set_all_user_settings( $user_settings ) { global $_updated_user_settings; $user_id = get_current_user_id(); if ( ! $user_id ) { return false; } if ( ! is_user_member_of_blog() ) { return null; } $settings = ''; foreach ( $user_settings as $name => $value ) { $_name = preg_replace( '/[^A-Za-z0-9_-]+/', '', $name ); $_value = preg_replace( '/[^A-Za-z0-9_-]+/', '', $value ); if ( ! empty( $_name ) ) { $settings .= $_name . '=' . $_value . '&'; } } $settings = rtrim( $settings, '&' ); parse_str( $settings, $_updated_user_settings ); update_user_option( $user_id, 'user-settings', $settings, false ); update_user_option( $user_id, 'user-settings-time', time(), false ); return true;}Changelog
Introduced in 2.8.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.0.4 tag, from
src/wp-includes/option.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.