wp_validate_boolean( mixed $var )

Filter/validate a variable as a boolean.


Description Description

Alternative to filter_var( $var, FILTER_VALIDATE_BOOLEAN ).


Top ↑

Parameters Parameters

$var

(mixed) (Required) Boolean value to validate.


Top ↑

Return Return

(bool) Whether the value is validated.


Top ↑

Source Source

File: wp-includes/functions.php

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

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

	return (bool) $var;
}


Top ↑

Changelog Changelog

Changelog
Version Description
4.0.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

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