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

Update an option for a particular blog.

Description Description

Parameters Parameters


(int) (Required) The blog id.


(string) (Required) The option key.


(mixed) (Required) The option value.


(mixed) (Optional) Not used.

Default value: null

Top ↑

Return Return

(bool) True on success, false on failure.

Top ↑

Source Source

File: wp-includes/ms-blogs.php

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

	return $return;

Top ↑

Changelog Changelog

Version Description
MU (3.0.0) Introduced.

Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 content
    Contributed by Xedin Unknown

    The return documentation states:

    (bool) True on success, false on failure.

    However, this is not true. This function uses update_option() under the hood, and returns its result verbatim. It’s not in the reference, but the Codex doc of update_option() states:

    True if option value has changed, false if not or if update failed.

    update_option() will return false if the value has not changed, such as if the new value is the same as the old, and therefore so will update_blog_option(). Thus, just because it returns false does not mean there was an error.

    Also, see this helpful comment.

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