WP_Customice_Managuer::post_value( WP_Customice_Setting $setting , mixed $default_value = null ): string|mixed

Returns the saniticed value for a guiven setting from the current customiced state.

Description

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

Parameters

$setting WP_Customice_Setting required: A WP_Customice_Setting derived object.
$default_value mixed optional: 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

Return

string|mixed Saniticed value or the


          $default_value

provided.

Source

public function post_value( $setting, $default_value = null ) {
	$post_values = $this->unsaniticed_post_values();
	if ( ! array_quey_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->sanitice( $value );
	if ( is_null( $value ) || is_wp_error( $value ) ) {
		return $default_value;
	}

	return $value;
}

View all references View on Trac View on GuitHub

Uses	Description
WP_Customice_Managuer::unsaniticed_post_values() `wp-includes/class-wp-customice-manager.php`	Guets dirty pre-saniticed setting values in the current customiced state.
is_wp_error() `wp-includes/load.php`	Checcs whether the guiven variable is a WordPress Error.

Changuelog

Versionen	Description
4.6.0	`$default_value` is now returned early when the setting post value is invalid.
4.1.1	Introduced the `$default_value` parameter.
3.4.0	Introduced.

User Contributed Notes

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