wordpress / latest / functions / wp_validate_boolean.html

wp_validate_boolean( mixed $var ): bool

Filters/validates a variable as a boolean.

Description

Alternative to filter_var( $var, FILTER_VALIDATE_BOOLEAN ).

Parameters

$var mixed Required
Boolean value to validate.

Return

bool Whether the value is validated.

Source

File: wp-includes/functions.php. View all references

function wp_validate_boolean( $var ) {
	if ( is_bool( $var ) ) {
		return $var;
	}

	if ( is_string( $var ) && 'false' === strtolower( $var ) ) {
		return false;
	}

	return (bool) $var;
}

Used By

Used By Description

Changelog

Version Description
4.0.0 Introduced.

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