update_blog_option() WordPress Function
The update_blog_option() function is used to update a blog option for the specified blog. The function takes three arguments: the blog id, the option key, and the option value. The function returns the new option value if the option was updated successfully, or false if the update failed.
update_blog_option( int $id, string $option, mixed $value, mixed $deprecated = null ) #
Update an option for a particular blog.
Parameters
- $id
(int)(Required)The blog ID.
- $option
(string)(Required)The option key.
- $value
(mixed)(Required)The option value.
- $deprecated
(mixed)(Optional)Not used.
Default value: null
Return
(bool) True if the value was updated, false otherwise.
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 );
restore_current_blog();
return $return;
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| MU (3.0.0) | Introduced. |