WP_Customize_Manager::post_value() │ public │ WP 3.4.0

Returns the sanitized value for a given setting from the current customized state.

The name "post_value" is a carry-over from when the customized state was exclusively sourced from $_POST['customized']. Nevertheless, the value returned will come from the current changeset post and from the incoming post data.

Method of the class: WP_Customize_Manager{}

No Hooks.

Return

String|Mixed. Sanitized value or the $default_value provided.

Usage

$WP_Customize_Manager = new WP_Customize_Manager();
$WP_Customize_Manager->post_value( $setting, $default_value );

$setting(WP_Customize_Setting) (required)

A WP_Customize_Setting derived object.

$default_value(mixed)

Value returned if $setting has no post value (added in 4.2.0) or the post value is invalid (added in 4.6.0).
Default: null

Notes

• See: WP_REST_Server::dispatch()
• See: WP_REST_Request::sanitize_params()
• See: WP_REST_Request::has_valid_params()

Changelog

WP_Customize_Manager::post_value() WP Customize Manager::post value code ^{WP 6.5.2}

public function post_value( $setting, $default_value = null ) {
	$post_values = $this->unsanitized_post_values();
	if ( ! array_key_exists( $setting->id, $post_values ) ) {
		return $default_value;
	}

	$value = $post_values[ $setting->id ];
	$valid = $setting->validate( $value );
	if ( is_wp_error( $valid ) ) {
		return $default_value;
	}

	$value = $setting->sanitize( $value );
	if ( is_null( $value ) || is_wp_error( $value ) ) {
		return $default_value;
	}

	return $value;
}