remove_theme_mod( string $name )

Description

Parameters

$namestring

Theme modification name.

Uses · 4

• get_theme_mods()Retrieves all theme modifications.
• remove_theme_mods()Removes theme modifications option for the active theme.
• get_option()Retrieves an option value based on an option name.
• update_option()Updates the value of an option that was already added.

Used by · 6

• Custom_Background::take_action()Executes custom background modification.
• Custom_Image_Header::set_header_image()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).
• WP_Customize_Background_Image_Setting::update()
• _delete_attachment_theme_mod()Checks an attachment being deleted to see if it's a header or background image.
• _delete_custom_logo_on_remove_site_logo()Removes the custom_logo theme-mod when the site_logo option gets deleted.
• switch_theme()Switches the theme.

Source

View on Trac ↗View on GitHub ↗

1138function remove_theme_mod( $name ) {1139	$mods = get_theme_mods();1140 1141	if ( ! isset( $mods[ $name ] ) ) {1142		return;1143	}1144 1145	unset( $mods[ $name ] );1146 1147	if ( empty( $mods ) ) {1148		remove_theme_mods();1149		return;1150	}1151 1152	$theme = get_option( 'stylesheet' );1153 1154	update_option( "theme_mods_$theme", $mods );1155}

History

Introduced in 2.1.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 7.1.0 tag, from src/wp-includes/theme.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.