Updates an option for a particular blog.
Parameters
$id
intrequired- The blog ID.
$option
stringrequired- The option key.
$value
mixedrequired- The option value.
$deprecated
mixedoptional- Not used.
Default:
null
Source
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 );
restore_current_blog();
return $return;
}
Changelog
Version | Description |
---|---|
MU (3.0.0) | Introduced. |
The return documentation states:
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 ofupdate_option()
states:update_option()
will returnfalse
if the value has not changed, such as if the new value is the same as the old, and therefore so willupdate_blog_option()
. Thus, just because it returnsfalse
does not mean there was an error.Also, see this helpful comment.