wp_validate_boolean( mixed $value ): bool

Filters/validates a variable as a boolean.

Contents

Description

Alternative to filter_var( $value, FILTER_VALIDATE_BOOLEAN ).

Top ↑

Parameters

$value mixed Required
Boolean value to validate.

Top ↑

Return

bool Whether the value is validated.

Top ↑

Source

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

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

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

	return (bool) $value;
}

View on Trac View on GitHub

Top ↑

Top ↑

Used By

Used By
Used By Description
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.
wp_video_shortcode() wp-includes/media.php

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

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

Builds the Audio shortcode output.

Top ↑

Changelog

Changelog
Version Description
4.0.0 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 1 content
    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
    Contributed by Daniel Pietrasik —

    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.