remove_theme_mod() │ WP 2.1.0

Remove theme modification name from current theme list.

If removing the name also removes all elements, then the entire option will be removed.

Uses: get_theme_mods(), update_option(), remove_theme_mods()
1 time — 0.001562 sec (very slow) | 50000 times — 2.79 sec (fast)

No Hooks.

Return

null. Nothing.

Usage

remove_theme_mod( $name );
$name(string) (required)
Theme modification name.

Examples

0

#1 Deleting special options 

// let's say we added an option like this
set_theme_mod( 'my_theme_option', 123 );

//and here we need to remove the option. Delete:
remove_theme_mod( 'my_theme_option' );

Changelog

Since 2.1.0 Introduced.

Code of remove_theme_mod() WP 6.0.1

wp-includes/theme.php 
function remove_theme_mod( $name ) {
	$mods = get_theme_mods();

	if ( ! isset( $mods[ $name ] ) ) {
		return;
	}

	unset( $mods[ $name ] );

	if ( empty( $mods ) ) {
		remove_theme_mods();
		return;
	}

	$theme = get_option( 'stylesheet' );

	update_option( "theme_mods_$theme", $mods );
}

Theme Modification API (theme mods options settings)

Other Theme Functions