wppaste
WordPress

add_blog_option( int $id, string $option, mixed $value ): bool

Since
MU (3.0.0)
Source
wp-includes/ms-blogs.php:404
Adds a new option for a given blog ID.

Description

You do not need to serialize values. If the value needs to be serialized, then it will be serialized before it is inserted into the database. Remember, resources can not be serialized or added as an option.

You can create options without values and then update the values later.
Existing options will not be updated and checks are performed to ensure that you aren't adding a protected WordPress option. Care should be taken to not name options the same as the ones which are protected.

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
A blog ID. Can be null to refer to the current blog.
$optionstring
Name of option to add. Expected to not be SQL-escaped.
$valuemixed
Option value, can be anything. Expected to not be SQL-escaped.

Return value

bool
True if the option was added, false otherwise.

Performance profile

How much work a call to add_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 add_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
16–25

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

  • optionoption read or writeadd_option()called directly
  • cacheobject cachewp_cache_get()one call below add_blog_option()
  • hookthird-party callbacksapply_filters()one call below add_blog_option()
  • serializeserialisationmaybe_serialize()one call below add_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 add_blog_option() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
!empty($id) && $id === false16get_current_blog_id(), add_option()
empty($id) && $id === false19get_current_blog_id(), get_current_blog_id(), add_option()
!empty($id) && $id !== false22get_current_blog_id(), switch_to_blog(), add_option(), restore_current_blog()
empty($id) && $id !== false25get_current_blog_id(), get_current_blog_id(), switch_to_blog(), add_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: 30 instructions, 16–25 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 · 4

Source code

View on Trac View on GitHub 

function add_blog_option( $id, $option, $value ) {	$id = (int) $id; 	if ( empty( $id ) ) {		$id = get_current_blog_id();	} 	if ( get_current_blog_id() === $id ) {		return add_option( $option, $value );	} 	switch_to_blog( $id );	$return = add_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.9.7 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.