W3cubDocs

/WordPress

Custom_Image_Header::reset_header_image()

Resets a header image to the default image for the theme.

Description

This method does not do anything if the theme does not have a default header image.

Source

final public function reset_header_image() {
	$this->process_default_headers();
	$default = get_theme_support( 'custom-header', 'default-image' );

	if ( ! $default ) {
		$this->remove_header_image();
		return;
	}

	$default = sprintf( $default, get_template_directory_uri(), get_stylesheet_directory_uri() );

	$default_data = array();
	foreach ( $this->default_headers as $header => $details ) {
		if ( $details['url'] === $default ) {
			$default_data = $details;
			break;
		}
	}

	set_theme_mod( 'header_image', $default );
	set_theme_mod( 'header_image_data', (object) $default_data );
}

Changelog

Version Description
3.4.0 Introduced.

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