W3cubDocs

/WordPress

_delete_attachment_theme_mod( int $id )

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

Description

If true it removes the theme modification which would be pointing at the deleted attachment.

Parameters

$idintrequired
The attachment ID.

Source

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

Version Description
6.6.0 Also removes site_logo option set by the site logo block.
4.5.0 Also removes custom logo theme mods.
4.3.0 Also removes header_image_data.
3.0.0 Introduced.

© 2003–2024 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/_delete_attachment_theme_mod