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

Add 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.

Parameters

$id: (int) (Required) A blog ID. Can be null to refer to the current blog.
$option: (string) (Required) Name of option to add. Expected to not be SQL-escaped.
$value: (mixed) (Optional) Option value, can be anything. Expected to not be SQL-escaped.

Return

(bool) True if the option was added, false otherwise.

Source

File: wp-includes/ms-blogs.php

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;
}

Uses

Uses	Description
wp-includes/load.php: get_current_blog_id()	Retrieve the current site ID.
wp-includes/option.php: add_option()	Adds a new option.
wp-includes/ms-blogs.php: switch_to_blog()	Switch the current blog.
wp-includes/ms-blogs.php: restore_current_blog()	Restore the current blog, after calling switch_to_blog().

Changelog

Version	Description
MU (3.0.0)	Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/add_blog_option