WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

wp_validate_boolean()

wp_validate_boolean( mixed $value ): bool

In this article

Back to top

Filters/validates a variable as a boolean.

Description

Alternative to filter_var( $value, FILTER_VALIDATE_BOOLEAN ).

Parameters

$valuemixedrequired
Boolean value to validate.

Return

bool Whether the value is validated.

Source

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

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

	return (bool) $value;
}

View all references View on Trac View on GitHub

Used byDescription
get_term_parents_list()wp-includes/category-template.php

Retrieves term parents with separator.

wp_xmlrpc_server::_toggle_sticky()wp-includes/class-wp-xmlrpc-server.php

Encapsulates the logic for sticking a post and determining if the user has permission to do so.

Changelog

VersionDescription
4.0.0Introduced.

User Contributed Notes

  1. Skip to note 2 content
    Daniel Pietrasik
    You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note

    wp_validate_boolean() tests:

    wp_validate_boolean(true)); //returns bool(true)
wp_validate_boolean(false)); //returns bool(false)
wp_validate_boolean('true')); //returns bool(true)
wp_validate_boolean('false')); //returns bool(false)
wp_validate_boolean('test')); //returns bool(true)
wp_validate_boolean(123)); //returns bool(true)
wp_validate_boolean(0)); //returns bool(false)
wp_validate_boolean(null)); //returns bool(false)
wp_validate_boolean([]); //returns bool(false)
wp_validate_boolean(['test']); //returns bool(true)
wp_validate_boolean([123]); //returns bool(true)
wp_validate_boolean(new StdClass()) //returns bool(true)
wp_validate_boolean()); //returns Error

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