W3cubDocs

/WordPress

delete_blog_option( int $id, string $option )

Removes option by name for a given blog id. Prevents removal of protected WordPress options.

Description

Parameters

$id

(int) (Required) A blog ID. Can be null to refer to the current blog.

$option

(string) (Required) Name of option to remove. Expected to not be SQL-escaped.

Return

(bool) True, if option is successfully deleted. False on failure.

Source

File: wp-includes/ms-blogs.php

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.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/delete_blog_option