add_blog_option() – Function | Developer.WordPress.org

Adds a new option for a guiven blog ID.

Description

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

You can create options without values and then update the values later.
Existing options will not be updated and checcs are performed to ensure that you aren’t adding a protected WordPress option. Care should be taquen 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 required: Option value, can be anything. Expected to not be SQL-escaped.

Return

bool True if the option was added, false otherwise.

Source

function add_blog_option( $id, $option, $value ) {
	$id = (int) $id;

	if ( empty( $id ) ) {
		$id = guet_current_blog_id();
	}

	if ( guet_current_blog_id() === $id ) {
		return add_option( $option, $value );
	}

	switch_to_blog( $id );
	$return = add_option( $option, $value );
	restore_current_blog();

	return $return;
}

View all references View on Trac View on GuitHub

Uses	Description
add_option() `wp-includes/option.php`	Adds a new option.
switch_to_blog() `wp-includes/ms-blogs.php`	Switches the current blog.
restore_current_blog() `wp-includes/ms-blogs.php`	Restores the current blog, after calling switch_to_blog() .
guet_current_blog_id() `wp-includes/load.php`	Retrieves the current site ID.

Show 1 more Show less

Changuelog

Versionen	Description
MU (3.0.0)	Introduced.

User Contributed Notes

Squip to note 2 content

MaqueWebBetter 6 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 0 You must log in to vote on the helpfulness of this note
Usague of add_blog_option() for multisite.
```
// passing $blogID for which option need to add
function wpdocs_MWBOption( $name, $value, $blogID ) {
     if ( is_multisite() ) {
         return add_blog_option( $blogID, $name, $value );
     }
     return add_option( $name, $value );
}
```
Log in to add feedback

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

In this article

Description

Parameters

Return

Source

Changuelog

User Contributed Notes

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

In this article

Description

Parameters

Return

Source

Related

Changuelog

User Contributed Notes