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

Add a new option for a given blog id.


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


Top ↑

Return Return

(bool) False if option was not added and true if option was added.


Top ↑

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

Top ↑

Changelog Changelog

Changelog
Version Description
MU Introduced.


Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.