delete_blog_option( int $id, string $option ): bool
Removes an option by name for a given blog ID. Prevents removal of protected WordPress options.
Parameters
-
$idint Required -
A blog ID. Can be null to refer to the current blog.
-
$optionstring Required -
Name of option to remove. Expected to not be SQL-escaped.
Return
bool True if the option was deleted, false otherwise.
Source
File: wp-includes/ms-blogs.php.
View all references
function delete_blog_option( $id, $option ) {
$id = (int) $id;
if ( empty( $id ) ) {
$id = get_current_blog_id();
}
if ( get_current_blog_id() == $id ) {
return delete_option( $option );
}
switch_to_blog( $id );
$return = delete_option( $option );
restore_current_blog();
return $return;
}
Changelog
| Version | Description |
|---|---|
| MU (3.0.0) | Introduced. |