WP_Theme_JSON::get_metadata_boolean( array $data, bool|array $path, bool $default_value = false ): bool

For metadata values that can either be booleans or paths to booleans, gets the value.

Description

$data = array( ‘color’ => array( ‘defaultPalette’ => true ) );

static::get_metadata_boolean( $data, false );
// => false

static::get_metadata_boolean( $data, array( 'color', 'defaultPalette' ) );
// => true

Parameters

$dataarrayrequired: The data to inspect.
$pathbool|arrayrequired: Boolean or path to a boolean.
$default_valuebooloptional: Default value if the referenced path is missing.

Default:false

Return

bool Value of boolean metadata.

Source

protected static function get_metadata_boolean( $data, $path, $default_value = false ) {
	if ( is_bool( $path ) ) {
		return $path;
	}

	if ( is_array( $path ) ) {
		$value = _wp_array_get( $data, $path );
		if ( null !== $value ) {
			return $value;
		}
	}

	return $default_value;
}

View all references View on Trac View on GitHub

Uses	Description
_wp_array_get()`wp-includes/functions.php`	Accesses an array in depth based on a path of keys.

Changelog

Version	Description
6.0.0	Introduced.

User Contributed Notes

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