WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

remove_theme_mod()

remove_theme_mod( string $name )

In this article

Back to top

Removes theme modification name from active theme list.

Description

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

Parameters

$namestringrequired
Theme modification name.

Source

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

View all references View on Trac View on GitHub

UsesDescription
remove_theme_mods()wp-includes/theme.php

Removes theme modifications option for the active theme.

get_theme_mods()wp-includes/theme.php

Retrieves all theme modifications.

update_option()wp-includes/option.php

Updates the value of an option that was already added.

get_option()wp-includes/option.php

Retrieves an option value based on an option name.

Show 2 moreShow less
Used byDescription
Custom_Image_Header::set_header_image()wp-admin/includes/class-custom-image-header.php

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

Custom_Background::take_action()wp-admin/includes/class-custom-background.php

Executes custom background modification.

_delete_attachment_theme_mod()wp-includes/theme.php

Checks an attachment being deleted to see if it’s a header or background image.

switch_theme()wp-includes/theme.php

Switches the theme.

WP_Customize_Background_Image_Setting::update()wp-includes/customize/class-wp-customize-background-image-setting.php

Changelog

VersionDescription
2.1.0Introduced.

User Contributed Notes

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