Title: WP_Customize_Header_Image_Setting
Published: April 25, 2014
Last modified: August 20, 2026

---

# class WP_Customize_Header_Image_Setting {}

## In this article

 * [Description](https://developer.wordpress.org/reference/classes/wp_customize_header_image_setting/?output_format=md#description)
    - [See also](https://developer.wordpress.org/reference/classes/wp_customize_header_image_setting/?output_format=md#see-also)
 * [Methods](https://developer.wordpress.org/reference/classes/wp_customize_header_image_setting/?output_format=md#methods)
 * [Source](https://developer.wordpress.org/reference/classes/wp_customize_header_image_setting/?output_format=md#source)
 * [Related](https://developer.wordpress.org/reference/classes/wp_customize_header_image_setting/?output_format=md#related)
 * [Changelog](https://developer.wordpress.org/reference/classes/wp_customize_header_image_setting/?output_format=md#changelog)

A setting that is used to filter a value, but will not save the results.

## 󠀁[Description](https://developer.wordpress.org/reference/classes/wp_customize_header_image_setting/?output_format=md#description)󠁿

Results should be properly handled using another setting or callback.

### 󠀁[See also](https://developer.wordpress.org/reference/classes/wp_customize_header_image_setting/?output_format=md#see-also)󠁿

 * [WP_Customize_Setting](https://developer.wordpress.org/reference/classes/wp_customize_setting/)

## 󠀁[Methods](https://developer.wordpress.org/reference/classes/wp_customize_header_image_setting/?output_format=md#methods)󠁿

| Name | Description | 
| [WP_Customize_Header_Image_Setting::update](https://developer.wordpress.org/reference/classes/wp_customize_header_image_setting/update/) | – |

## 󠀁[Source](https://developer.wordpress.org/reference/classes/wp_customize_header_image_setting/?output_format=md#source)󠁿

    ```php
    final class WP_Customize_Header_Image_Setting extends WP_Customize_Setting {

    	/**
    	 * Unique string identifier for the setting.
    	 *
    	 * @since 3.4.0
    	 * @var string
    	 */
    	public $id = 'header_image_data';

    	/**
    	 * @since 3.4.0
    	 * @since 7.0.0 Return type updated from void to true for compatibility with base class.
    	 *
    	 * @global Custom_Image_Header $custom_image_header
    	 *
    	 * @param mixed $value The value to update.
    	 * @return true Always returns true.
    	 */
    	public function update( $value ) {
    		global $custom_image_header;

    		// If _custom_header_background_just_in_time() fails to initialize $custom_image_header when not is_admin().
    		if ( empty( $custom_image_header ) ) {
    			require_once ABSPATH . 'wp-admin/includes/class-custom-image-header.php';
    			$args                   = get_theme_support( 'custom-header' );
    			$admin_head_callback    = $args[0]['admin-head-callback'] ?? null;
    			$admin_preview_callback = $args[0]['admin-preview-callback'] ?? null;
    			$custom_image_header    = new Custom_Image_Header( $admin_head_callback, $admin_preview_callback );
    		}

    		/*
    		 * If the value doesn't exist (removed or random),
    		 * use the header_image value.
    		 */
    		if ( ! $value ) {
    			$value = $this->manager->get_setting( 'header_image' )->post_value();
    		}

    		if ( is_array( $value ) && isset( $value['choice'] ) ) {
    			$custom_image_header->set_header_image( $value['choice'] );
    		} else {
    			$custom_image_header->set_header_image( $value );
    		}
    		return true;
    	}
    }
    ```

[View all references](https://developer.wordpress.org/reference/files/wp-includes/customize/class-wp-customize-header-image-setting.php/)
[View on Trac](https://core.trac.wordpress.org/browser/tags/7.1/src/wp-includes/customize/class-wp-customize-header-image-setting.php#L19)
[View on GitHub](https://github.com/WordPress/wordpress-develop/blob/7.1/src/wp-includes/customize/class-wp-customize-header-image-setting.php#L19-L65)

## 󠀁[Related](https://developer.wordpress.org/reference/classes/wp_customize_header_image_setting/?output_format=md#related)󠁿

| Uses | Description | 
| [WP_Customize_Setting](https://developer.wordpress.org/reference/classes/wp_customize_setting/)`wp-includes/class-wp-customize-setting.php` |

Customize Setting class.

  |

## 󠀁[Changelog](https://developer.wordpress.org/reference/classes/wp_customize_header_image_setting/?output_format=md#changelog)󠁿

| Version | Description | 
| [3.4.0](https://developer.wordpress.org/reference/since/3.4.0/) | Introduced. |

## User Contributed Notes

You must [log in](https://login.wordpress.org/?redirect_to=https%3A%2F%2Fdeveloper.wordpress.org%2Freference%2Fclasses%2Fwp_customize_header_image_setting%2F)
before being able to contribute a note or feedback.