_delete_attachment_theme_mod( int $id )
- Since
- 3.0.0, 4.3.0, 4.5.0, 6.6.0
- Source
wp-includes/theme.php:3442
Description
If true it removes the theme modification which would be pointing at the deleted attachment.
Compatibility
- WordPress
- since 6.6.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
$idint- The attachment ID.
Performance profile
How much work a call to _delete_attachment_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
- Heavy
- Scaling
- Constant
- Instructions
- 24–50
- Plugin surface
- None
- Called by
- 0
Reaches the database via get_post().
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 50.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- optionoption read or write
get_option()called directly - querycontent query
get_post()one call below _delete_attachment_theme_mod() - hookthird-party callbacks
apply_filters()one call below _delete_attachment_theme_mod() - cacheobject cache
wp_cache_get()one call below _delete_attachment_theme_mod() - serializeserialisation
maybe_unserialize()one call below _delete_attachment_theme_mod()
Further down the call graph this can also reach transient. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 14 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost _delete_attachment_theme_mod() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 24–32 | wp_get_attachment_url(), get_header_image(), get_background_image(), get_theme_mod(), get_option() |
$background_image === false | 29–35 | wp_get_attachment_url(), get_header_image(), get_background_image(), get_theme_mod(), get_option(), remove_theme_mod() |
$site_logo_id === false | 29–35 | wp_get_attachment_url(), get_header_image(), get_background_image(), get_theme_mod(), get_option(), delete_option() |
| always | 32–38 | wp_get_attachment_url(), get_header_image(), get_background_image(), get_theme_mod(), get_option(), remove_theme_mod(), remove_theme_mod() |
$site_logo_id === false && $background_image === false | 34–38 | wp_get_attachment_url(), get_header_image(), get_background_image(), get_theme_mod(), get_option(), delete_option(), remove_theme_mod() |
$background_image === false | 37–41 | wp_get_attachment_url(), get_header_image(), get_background_image(), get_theme_mod(), get_option(), remove_theme_mod(), remove_theme_mod(), remove_theme_mod() |
$site_logo_id === false && $header_image === false | 37–41 | wp_get_attachment_url(), get_header_image(), get_background_image(), get_theme_mod(), get_option(), delete_option(), remove_theme_mod(), remove_theme_mod() |
$custom_logo_id === false && $site_logo_id === false | 37–41 | wp_get_attachment_url(), get_header_image(), get_background_image(), get_theme_mod(), get_option(), remove_theme_mod(), remove_theme_mod(), delete_option() |
$custom_logo_id === false && $header_image === false | 40–44 | wp_get_attachment_url(), get_header_image(), get_background_image(), get_theme_mod(), get_option(), remove_theme_mod(), remove_theme_mod(), remove_theme_mod(), remove_theme_mod() |
$site_logo_id === false && $header_image === false && $background_image === false | 42–44 | wp_get_attachment_url(), get_header_image(), get_background_image(), get_theme_mod(), get_option(), delete_option(), remove_theme_mod(), remove_theme_mod(), remove_theme_mod() |
$custom_logo_id === false && $site_logo_id === false && $background_image === false | 42–44 | wp_get_attachment_url(), get_header_image(), get_background_image(), get_theme_mod(), get_option(), remove_theme_mod(), remove_theme_mod(), delete_option(), remove_theme_mod() |
$custom_logo_id === false && $header_image === false && $background_image === false | 45–47 | wp_get_attachment_url(), get_header_image(), get_background_image(), get_theme_mod(), get_option(), remove_theme_mod(), remove_theme_mod(), remove_theme_mod(), remove_theme_mod(), remove_theme_mod() |
2 further outcomes, up to 50 instructions
$custom_logo_id === false && $site_logo_id === false && $header_image === false | 45–47 | wp_get_attachment_url(), get_header_image(), get_background_image(), get_theme_mod(), get_option(), remove_theme_mod(), remove_theme_mod(), delete_option(), remove_theme_mod(), remove_theme_mod() |
$custom_logo_id === false && $site_logo_id === false && $header_image === false && $background_image === false | 50 | wp_get_attachment_url(), get_header_image(), get_background_image(), get_theme_mod(), get_option(), remove_theme_mod(), remove_theme_mod(), delete_option(), remove_theme_mod(), remove_theme_mod(), remove_theme_mod() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 50 instructions, 24–50 executed per call, 8 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 · 7
- wp_get_attachment_url()Retrieves the URL for an attachment.
- get_header_image()Retrieves header image for custom header.
- get_background_image()Retrieves background image for custom background.
- get_theme_mod()Retrieves theme modification value for the active theme.
- get_option()Retrieves an option value based on an option name.
- remove_theme_mod()Removes theme modification name from active theme list.
- delete_option()Removes an option by name. Prevents removal of protected WordPress options.
Source code
function _delete_attachment_theme_mod( $id ) { $attachment_image = wp_get_attachment_url( $id ); $header_image = get_header_image(); $background_image = get_background_image(); $custom_logo_id = (int) get_theme_mod( 'custom_logo' ); $site_logo_id = (int) get_option( 'site_logo' ); if ( $custom_logo_id && $custom_logo_id === $id ) { remove_theme_mod( 'custom_logo' ); remove_theme_mod( 'header_text' ); } if ( $site_logo_id && $site_logo_id === $id ) { delete_option( 'site_logo' ); } if ( $header_image && $header_image === $attachment_image ) { remove_theme_mod( 'header_image' ); remove_theme_mod( 'header_image_data' ); } if ( $background_image && $background_image === $attachment_image ) { remove_theme_mod( 'background_image' ); }}Changelog
Introduced in 3.0.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
site_logo option set by the site logo block.from the docblockheader_image_data.from the docblockAbout 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.