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

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'].

Parameters

$setting_idstringrequired
ID for the WP_Customize_Setting instance.
$valuemixedrequired
Post value.

Source

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 );
}

Hooks

do_action( ‘customize_post_value_set’, string $setting_id, mixed $value, WP_Customize_Manager $manager )

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

do_action( “customize_post_value_set_{$setting_id}”, mixed $value, WP_Customize_Manager $manager )

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

Changelog

VersionDescription
4.2.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.