wppaste
WordPress

update_blog_option( int $id, string $option, mixed $value, mixed $deprecated = null ): bool

Since
MU (3.0.0)
Source
wp-includes/ms-blogs.php:460
Updates an option for a particular blog.

Compatibility

WordPress
since MU (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

$idint
The blog ID.
$optionstring
The option key.
$valuemixed
The option value.
$deprecatedmixedoptional
Not used.Default: null

Return value

bool
True if the value was updated, false otherwise.

Performance profile

How much work a call to update_blog_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_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
17–27

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

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 it touches

  • optionoption read or writeupdate_option()called directly
  • hookthird-party callbacksdo_action()one call below update_blog_option()
  • serializeserialisationmaybe_serialize()one call below update_blog_option()
  • cacheobject cachewp_cache_get()one call below update_blog_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 · 4 distinct outcomes

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

WhenInstructionsCalls it makes
$deprecated === null && $id === false17get_current_blog_id(), update_option()
$deprecated !== null && $id === false21_deprecated_argument(), get_current_blog_id(), update_option()
$deprecated === null && $id !== false23get_current_blog_id(), switch_to_blog(), update_option(), restore_current_blog()
$deprecated !== null && $id !== false27_deprecated_argument(), get_current_blog_id(), switch_to_blog(), update_option(), restore_current_blog()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 32 instructions, 17–27 executed per call, 2 branches. 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 · 5

Used by · 1

Source code

View on Trac View on GitHub 

function update_blog_option( $id, $option, $value, $deprecated = null ) {	$id = (int) $id; 	if ( null !== $deprecated ) {		_deprecated_argument( __FUNCTION__, '3.1.0' );	} 	if ( get_current_blog_id() === $id ) {		return update_option( $option, $value );	} 	switch_to_blog( $id );	$return = update_option( $option, $value );	restore_current_blog(); 	return $return;}

Changelog

Introduced in MU (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/ms-blogs.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.