wppaste
WordPress

WP_Customize_Manager::set_post_value( string $setting_id, mixed $value )

Since
4.2.0
Source
wp-includes/class-wp-customize-manager.php:1866
Overrides a setting's value in the current customized state.

Description

The name "post_value" is a carry-over from when the customized state was exclusively sourced from $_POST['customized'].

Compatibility

WordPress
since 4.2.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

$setting_idstring
ID for the WP_Customize_Setting instance.
$valuemixed
Post value.

Performance profile

How much work a call to WP_Customize_Manager::set_post_value() 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
Trivial

Touches nothing outside its own arguments.

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
22

Executed per call on PHP 8.5. The body compiles to 22.

Plugin surface
2 hooks

Third-party callbacks on 'customize_post_value_set_{$setting_id}', 'customize_post_value_set' run inside this call, and their cost is not bounded by anything here.

Called by
2

2 places in core call this, so the cost is paid more often than your own code shows.

What it touches

  • hookthird-party callbacksdo_action()called directly

What one call costs · 1 distinct outcome

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Customize_Manager::set_post_value() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
always22->unsanitized_post_values(), do_action(), do_action()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 22 instructions, 22 executed per call, 0 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 · 2

2 hooks fire while WP_Customize_Manager::set_post_value() runs, in this order:

  1. do_action( customize_post_value_set_{$setting_id} )actionline 1882 (+16 into the body)

    Announces when a specific setting's unsanitized post value has been set.

  2. do_action( customize_post_value_set )actionline 1898 (+32 into the body)

    Announces when any setting's unsanitized post value has been set.

Uses · 2

Used by · 2

Source code

	public function set_post_value( $setting_id, $value ) {		$this->unsanitized_post_values(); // Populate _post_values from $_POST['customized'].		$this->_post_values[ $setting_id ] = $value; 		/**		 * Announces when a specific setting's unsanitized post value has been set.		 *		 * Fires when the WP_Customize_Manager::set_post_value() method is called.		 *		 * The dynamic portion of the hook name, `$setting_id`, refers to the setting ID.		 *		 * @since 4.4.0		 *		 * @param mixed                $value   Unsanitized setting post value.		 * @param WP_Customize_Manager $manager WP_Customize_Manager instance.		 */		do_action( "customize_post_value_set_{$setting_id}", $value, $this ); 		/**		 * Announces when any setting's unsanitized post value has been set.		 *		 * Fires when the WP_Customize_Manager::set_post_value() method is called.		 *		 * This is useful for `WP_Customize_Setting` instances to watch		 * in order to update a cached previewed value.		 *		 * @since 4.4.0		 *		 * @param string               $setting_id Setting ID.		 * @param mixed                $value      Unsanitized setting post value.		 * @param WP_Customize_Manager $manager    WP_Customize_Manager instance.		 */		do_action( 'customize_post_value_set', $setting_id, $value, $this );	}

Changelog

Introduced in 4.2.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 6.9.7 tag, from src/wp-includes/class-wp-customize-manager.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.