update_site_option( string $option, mixed $value ): bool

Compatibility

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

Parameters

$optionstring

Name of the option. Expected to not be SQL-escaped.

$valuemixed

Option value. Expected to not be SQL-escaped.

Return value

bool

True if the value was updated, false otherwise.

Performance profile

How much work a call to update_site_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

Moderate

Reads stored settings via update_site_option(), cached per request but not free on a cold cache.

Scaling

Constant

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

Instructions

8

Executed per call on PHP 8.5. The body compiles to 8.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

21

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

What it touches

• optionnetwork optionupdate_site_option()this function does it
• hookthird-party callbacksapply_filters()one call below update_site_option()
• serializeserialisationmaybe_serialize()one call below update_site_option()
• cacheobject cachewp_cache_get()one call below update_site_option()

Further down the call graph this can also reach query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 1 distinct outcome

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

Uses · 1

• update_network_option()Updates the value of a network option that was already added.

Used by · 21

• WP_Automatic_Updater::after_core_update()Checks whether to send an email and avoid processing future updates after attempting a core update.
• WP_Automatic_Updater::send_email()Sends an email upon the completion or failure of a background core update.
• WP_Plugins_List_Table::prepare_items()Prepares the list of items for displaying.
• WP_Recovery_Mode_Cookie_Service::recovery_mode_hash()Gets a form of `wp_hash()` specific to Recovery Mode.
• WP_Theme::network_disable_theme()Disables a theme for all sites on the current network.
• WP_Theme::network_enable_theme()Enables a theme for all sites on the current network.
• _upgrade_core_deactivate_incompatible_plugins()
• activate_plugin()Attempts activation of plugin in a "sandbox" and redirects on success.
• deactivate_plugins()Deactivates a single plugin or multiple plugins.
• deactivated_plugins_notice()Renders an admin notice when a plugin was deactivated during an update.
• dismiss_core_update()Dismisses core update.
• grant_super_admin()Grants Super Admin privileges.

Source code

View on Trac ↗View on GitHub ↗

1983function update_site_option( $option, $value ) {1984	return update_network_option( null, $option, $value );1985}

Changelog

Introduced in 2.8.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 7.1.0 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.