wp_validate_boolean( mixed $var )

Filter/validate 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 

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
wp-includes/category-template.php: get_term_parents_list()

Retrieves term parents with separator.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::_toggle_sticky()

Encapsulate the logic for sticking a post and determining if the user has permission to do so
wp-includes/media.php: wp_video_shortcode()

Builds the Video shortcode output.
wp-includes/media.php: wp_playlist_shortcode()

Builds the Playlist shortcode output.
wp-includes/media.php: wp_audio_shortcode()

Builds the Audio shortcode output.

Changelog

Version Description
4.0.0 Introduced.

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