remove_theme_mod() WordPress Function

The remove_theme_mod() function allows you to remove a theme modification setting from the current theme. This function takes a single parameter, which is the name of the setting to remove.

remove_theme_mod( string $name ) #

Removes theme modification name from active theme list.


Description

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


Top ↑

Parameters

$name

(string)(Required)Theme modification name.


Top ↑

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


Top ↑

Changelog

Changelog
VersionDescription
2.1.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.

Show More