remove_theme_mod( string $name )

Remove theme modification name from current theme list.

Description

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

Parameters

$name

(Required) Theme modification name.

Source

File: 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 );
}

Expand Source Code View on GitHub

Related

Uses

Uses
Uses Description
wp-includes/theme.php: get_theme_mods()

Retrieve all theme modifications.
wp-includes/theme.php: remove_theme_mods()

Remove theme modifications option for current theme.
wp-includes/option.php: update_option()

Update the value of an option that was already added.
wp-includes/option.php: get_option()

Retrieves an option value based on an option name.

Used By

Used By
Used By Description
wp-includes/customize/class-wp-customize-background-image-setting.php: WP_Customize_Background_Image_Setting::update()
wp-includes/theme.php: _delete_attachment_theme_mod()

Checks an attachment being deleted to see if it’s a header or background image.
wp-includes/theme.php: switch_theme()

Switches the theme.
wp-admin/custom-background.php: Custom_Background::take_action()

Execute custom background modification.
wp-admin/custom-header.php: Custom_Image_Header::set_header_image()

Choose a header image, selected from existing uploaded and default headers, or provide an array of uploaded header data (either new, or from media library).

Changelog

Changelog
Version Description
WP-2.1.0 Introduced.