wppaste
WordPress

WP_Customize_Header_Image_Setting

Since
3.4.0
Source
wp-includes/customize/class-wp-customize-header-image-setting.php:19
A setting that is used to filter a value, but will not save the results.

Description

Results should be properly handled using another setting or callback.

Compatibility

WordPress
since 3.4.0
  • 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).

Properties · 1

$idstringpublic
Unique string identifier for the setting.

Methods · 1

Source code

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;	}}

Changelog

Introduced in 3.4.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/customize/class-wp-customize-header-image-setting.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.