delete_blog_option( int $id, string $option ): bool

In this article

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

Parameters

$idintrequired
A blog ID. Can be null to refer to the current blog.
$optionstringrequired
Name of option to remove. Expected to not be SQL-escaped.

Return

bool True if the option was deleted, false otherwise.

Source

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

VersionDescription
MU (3.0.0)Introduced.

User Contributed Notes

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