remove_theme_mod( string $name )
- Since
- 2.1.0
- Source
wp-includes/theme.php:1128
Description
If removing the name also removes all elements, then the entire option will be removed.
Compatibility
- WordPress
- since 2.1.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$namestring- Theme modification name.
Performance profile
How much work a call to remove_theme_mod() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Moderate
- Scaling
- Constant
- Instructions
- 7–19
- Plugin surface
- None
- Called by
- 6
Reads stored settings via get_option(), cached per request but not free on a cold cache.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 23.
Nothing here hands control to plugin code.
6 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- optionoption read or write
get_option()called directly - hookthird-party callbacks
apply_filters()one call below remove_theme_mod() - cacheobject cache
wp_cache_get()one call below remove_theme_mod() - serializeserialisation
maybe_unserialize()one call below remove_theme_mod()
Further down the call graph this can also reach transient and query. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 3 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost remove_theme_mod() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!isset($mods[$name]) | 7 | get_theme_mods() |
isset($mods[$name]) && empty($mods) | 12 | get_theme_mods(), remove_theme_mods() |
isset($mods[$name]) && !empty($mods) | 19 | get_theme_mods(), get_option(), update_option() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 23 instructions, 7–19 executed per call, 2 branches. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
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 code
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 );}Changelog
Introduced in 2.1.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 6.7.7 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.