WP_Theme_JSON::get_metadata_boolean( array $data, bool|array $path, bool $default = 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[/code]


Top ↑

Parameters

$data array Required
The data to inspect.
$path bool|array Required
Boolean or path to a boolean.
$default bool Optional
Default value if the referenced path is missing.

Default: false


Top ↑

Return

bool Value of boolean metadata.


Top ↑

Source

File: wp-includes/class-wp-theme-json.php. View all references

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

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

	return $default;
}


Top ↑

Changelog

Changelog
Version Description
6.0.0 Introduced.

Top ↑

User Contributed Notes

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