W3cubDocs

/WordPress

rest_sanitize_boolean( bool|string|int $value )

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

Description

Parameters

$value

(bool|string|int) (Required) The value being evaluated.

Return

(boolean) Returns the proper associated boolean value.

Source

File: wp-includes/rest-api.php

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

Changelog

Version Description
4.7.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/rest_sanitize_boolean