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

Parameters

$idint

A blog ID. Can be null to refer to the current blog.

$optionstring

Name of option to remove. Expected to not be SQL-escaped.

Return

bool

True if the option was deleted, false otherwise.

Uses · 4

• get_current_blog_id()Retrieves the current site ID.
• delete_option()Removes an option by name. Prevents removal of protected WordPress options.
• switch_to_blog()Switches the current blog.
• restore_current_blog()Restores the current blog, after calling switch_to_blog().

Source

View on Trac ↗View on GitHub ↗

426function delete_blog_option( $id, $option ) {427	$id = (int) $id;428 429	if ( empty( $id ) ) {430		$id = get_current_blog_id();431	}432 433	if ( get_current_blog_id() === $id ) {434		return delete_option( $option );435	}436 437	switch_to_blog( $id );438	$return = delete_option( $option );439	restore_current_blog();440 441	return $return;442}

History

Introduced in MU (3.0.0). Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/ms-blogs.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.