WP_Customize_Header_Image_Setting WordPress Class
The WP_Customize_Header_Image_Setting class is used to represent a header image setting in the WordPress Customizer. This class allows you to easily add a header image setting to the Customizer and set its properties.
WP_Customize_Header_Image_Setting #
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.
See also
Source
File: wp-includes/customize/class-wp-customize-header-image-setting.php
final class WP_Customize_Header_Image_Setting extends WP_Customize_Setting { public $id = 'header_image_data'; /** * @since 3.4.0 * * @global Custom_Image_Header $custom_image_header * * @param mixed $value The value to update. */ 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 = isset( $args[0]['admin-head-callback'] ) ? $args[0]['admin-head-callback'] : null; $admin_preview_callback = isset( $args[0]['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 ); } } }
Expand full source codeCollapse full source codeView on TracView on GitHub
Methods
Changelog
Version | Description |
---|---|
3.4.0 | Introduced. |