WP_Customize_Header_Image_Setting

30final class WP_Customize_Header_Image_Setting extends WP_Customize_Setting {31 32	/**33	 * Unique string identifier for the setting.34	 *35	 * @since 3.4.036	 * @var string37	 */38	public $id = 'header_image_data';39 40	/**41	 * @since 3.4.042	 *43	 * @global Custom_Image_Header $custom_image_header44	 *45	 * @param mixed $value The value to update.46	 */47	public function update( $value ) {48		global $custom_image_header;49 50		// If _custom_header_background_just_in_time() fails to initialize $custom_image_header when not is_admin().51		if ( empty( $custom_image_header ) ) {52			require_once ABSPATH . 'wp-admin/includes/class-custom-image-header.php';53			$args                   = get_theme_support( 'custom-header' );54			$admin_head_callback    = isset( $args[0]['admin-head-callback'] ) ? $args[0]['admin-head-callback'] : null;55			$admin_preview_callback = isset( $args[0]['admin-preview-callback'] ) ? $args[0]['admin-preview-callback'] : null;56			$custom_image_header    = new Custom_Image_Header( $admin_head_callback, $admin_preview_callback );57		}58 59		/*60		 * If the value doesn't exist (removed or random),61		 * use the header_image value.62		 */63		if ( ! $value ) {64			$value = $this->manager->get_setting( 'header_image' )->post_value();65		}66 67		if ( is_array( $value ) && isset( $value['choice'] ) ) {68			$custom_image_header->set_header_image( $value['choice'] );69		} else {70			$custom_image_header->set_header_image( $value );71		}72	}73 74	/**75	 * Sanitizes a header value.76	 *77	 * The value is expected to be one of the following:78	 *79	 * - An array of header image data, with the keys `attachment_id`, `url`, `thumbnail_url`, `timestamp`, `width`,80	 *   `height`, `alt_text`, and `attachment_parent`, as supplied by {@see get_uploaded_header_images()}. Any other81	 *   key is discarded.82	 * - An array with a `choice` key, being the legacy format in which any of the other accepted values is nested.83	 * - The string `remove-header`, `random-default-image`, or `random-uploaded-image`.84	 * - A string corresponding to one of the keys for the array returned by {@see get_uploaded_header_images()}, or85	 *   one of the keys for the array passed into {@see register_default_headers()}.86	 *87	 * @since 7.1.188	 *89	 * @see WP_Customize_Header_Image_Setting::update()90	 * @see Custom_Image_Header::set_header_image()91	 *92	 * @param mixed $value Value to sanitize.93	 * @return array|string|WP_Error|null Sanitized value, or `null`/`WP_Error` if invalid. The array holds94	 *                                    the header image data, or that data nested under a `choice` key,95	 *                                    before the `customize_sanitize_header_image_data` filter, which96	 *                                    may return anything, is applied to it.97	 *98	 * @phpstan-return array<mixed, mixed>|string|WP_Error|null99	 */100	public function sanitize( $value ) {101		/*102		 * The update() method unwraps the legacy `choice` format before handing the value off to103		 * Custom_Image_Header::set_header_image(), so the nested value is what must be sanitized.104		 */105		if ( is_array( $value ) && isset( $value['choice'] ) ) {106			$choice = $this->sanitize_choice( $value['choice'] );107			if ( is_null( $choice ) || is_wp_error( $choice ) ) {108				return $choice;109			}