WP_Customize_Setting::update( mixed $value ): bool
- Since
- 3.4.0
- Source
wp-includes/class-wp-customize-setting.php:686
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.
Return value
bool- The result of saving the value.
Performance profile
How much work a call to WP_Customize_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
- 12–35
- Plugin surface
- 1 hook
- Called by
- 1
Reaches the database via WP_Customize_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.
Third-party callbacks on 'customize_update_{$this->type}' run inside this call, and their cost is not bounded by anything here.
1 place in core call this, so the cost is paid more often than your own code shows.
What it touches
- sqldatabase query
WP_Customize_Setting::update()this function does it - hookthird-party callbacks
do_action()called directly
What one call costs · 3 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Customize_Setting::update() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 12–15 | ->set_root_value() |
| always | 24 | do_action(), has_action() |
| always | 32–35 | ->multidimensional_replace(), ->set_root_value() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 54 instructions, 12–35 executed per call, 3 branches. The work does not change between versions.
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.
Hooks and filters fired · 1
One hook fires while WP_Customize_Setting::update() runs, in this order:
- do_action( customize_update_{$this->type} )actionline 709 (+23 into the body)
Fires when the WP_Customize_Setting::update() method is called for settings not handled as theme_mods or options.
Uses · 4
- do_action()Calls the callback functions that have been added to an action hook.
- has_action()Checks if any action has been registered for a hook.
- WP_Customize_Setting::set_root_value()Set the root value for a setting, especially for multidimensional ones.
- WP_Customize_Setting::multidimensional_replace()Will attempt to replace a specific value in a multidimensional array.
Used by · 1
- WP_Customize_Setting::save()Checks user capabilities and theme supports, and then saves the value of the setting.
Source code
protected function update( $value ) { $id_base = $this->id_data['base']; if ( 'option' === $this->type || 'theme_mod' === $this->type ) { if ( ! $this->is_multidimensional_aggregated ) { return $this->set_root_value( $value ); } else { $root = self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['root_value']; $root = $this->multidimensional_replace( $root, $this->id_data['keys'], $value ); self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['root_value'] = $root; return $this->set_root_value( $root ); } } else { /** * Fires when the WP_Customize_Setting::update() method is called for settings * not handled as theme_mods or options. * * The dynamic portion of the hook name, `$this->type`, refers to the type of setting. * * @since 3.4.0 * * @param mixed $value Value of the setting. * @param WP_Customize_Setting $setting WP_Customize_Setting instance. */ do_action( "customize_update_{$this->type}", $value, $this ); return (bool) has_action( "customize_update_{$this->type}" ); } }Changelog
Introduced in 3.4.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.0.4 tag, from
src/wp-includes/class-wp-customize-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.