rest_sanitize_boolean() │ WP 4.7.0

Changes a boolean-like value into the proper boolean value.

No Hooks.

Return

true|false. Returns the proper associated boolean value.

Usage

rest_sanitize_boolean( $value );

$value(true|false|string|int) (required)

The value being evaluated.

Changelog

rest_sanitize_boolean() rest sanitize boolean code ^{WP 6.5.2}

function rest_sanitize_boolean( $value ) {
	// String values are translated to `true`; make sure 'false' is false.
	if ( is_string( $value ) ) {
		$value = strtolower( $value );
		if ( in_array( $value, array( 'false', '0' ), true ) ) {
			$value = false;
		}
	}

	// Everything else will map nicely to boolean.
	return (bool) $value;
}