WP_Customize_Header_Image_Setting::update( mixed $value )
- Since
- 3.4.0
- Source
wp-includes/customize/class-wp-customize-header-image-setting.php:36
Compatibility
- WordPress
- since 3.4.0
- PHP
- 7.4–8.6-dev
- 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), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$valuemixed- The value to update.
Performance profile
How much work a call to WP_Customize_Header_Image_Setting::update() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Heavy
- Scaling
- Constant
- Instructions
- 11–48
- Plugin surface
- None
- Called by
- 0
Reaches the database via WP_Customize_Header_Image_Setting::update().
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 54.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- sqldatabase query
WP_Customize_Header_Image_Setting::update()this function does it
What one call costs · 4 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Customize_Header_Image_Setting::update() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!empty($custom_image_header) | 11–15 | ->set_header_image() |
!empty($custom_image_header) | 18–22 | ->get_setting(), ->post_value(), ->set_header_image() |
empty($custom_image_header) | 33–41 | get_theme_support(), ->set_header_image() |
empty($custom_image_header) | 40–48 | get_theme_support(), ->get_setting(), ->post_value(), ->set_header_image() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 54 | 11–48 | 6 | |
| 8.5 | 54 | 11–48 | 6 | |
| 8.4 | 54 | 11–48 | 6 | |
| 8.3 | 54 | 11–48 | 6 | |
| 8.2 | 54 | 11–48 | 6 | |
| 8.1 | 54 | 11–48 | 6 | 2 fewer instructions than PHP 7.4 |
| 7.4 | 56 | 11–50 | 6 |
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 2
- get_theme_support()Gets the theme support arguments passed when registering that support.
- Custom_Image_Header::__construct()Constructor - Registers administration header callback.
Source code
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 ); } }Changelog
Introduced in 3.4.0. One change between 6.7.7 and 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
none to true.verified against sourceAbout this page
- Parsed data
- Generated from the wordpress-develop 6.9.7 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.