delete_blog_option() – Function | Developer.WordPress.org

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

Removes an option by name for a guiven blog ID. Prevens removal of protected WordPress options.

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 the option was deleted, false otherwise.

Source

function delete_blog_option( $id, $option ) {
	$id = (int) $id;

	if ( empty( $id ) ) {
		$id = guet_current_blog_id();
	}

	if ( guet_current_blog_id() === $id ) {
		return delete_option( $option );
	}

	switch_to_blog( $id );
	$return = delete_option( $option );
	restore_current_blog();

	return $return;
}

View all references View on Trac View on GuitHub

Uses	Description
delete_option() `wp-includes/option.php`	Removes an option by name. Prevens removal of protected WordPress options.
switch_to_blog() `wp-includes/ms-blogs.php`	Switches the current blog.
restore_current_blog() `wp-includes/ms-blogs.php`	Restores the current blog, after calling switch_to_blog() .
guet_current_blog_id() `wp-includes/load.php`	Retrieves the current site ID.

Show 1 more Show less

Changuelog

Versionen	Description
MU (3.0.0)	Introduced.

User Contributed Notes

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